Package org.kurento.client
Interface ImageOverlayFilter
-
- All Superinterfaces:
Filter
,KurentoObject
,MediaElement
,MediaObject
public interface ImageOverlayFilter extends Filter
ImageOverlayFilter interface. This type ofFilter
draws an image in a configured position over a video feed.
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static class
ImageOverlayFilter.Builder
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
addImage(String id, String uri, float offsetXPercent, float offsetYPercent, float widthPercent, float heightPercent, boolean keepAspectRatio, boolean center)
Add an image to be used as overlay.void
addImage(String id, String uri, float offsetXPercent, float offsetYPercent, float widthPercent, float heightPercent, boolean keepAspectRatio, boolean center, Continuation<Void> cont)
Asynchronous version of addImage:Continuation.onSuccess(F)
is called when the action is done.void
addImage(Transaction tx, String id, String uri, float offsetXPercent, float offsetYPercent, float widthPercent, float heightPercent, boolean keepAspectRatio, boolean center)
Add an image to be used as overlay.void
removeImage(String id)
Remove the image with the given ID.void
removeImage(String id, Continuation<Void> cont)
Asynchronous version of removeImage:Continuation.onSuccess(F)
is called when the action is done.void
removeImage(Transaction tx, String id)
Remove the image with the given ID.-
Methods inherited from interface org.kurento.client.KurentoObject
addEventListener, invoke, isCommited, release, release, release, removeEventListener, waitCommited, whenCommited, whenCommited
-
Methods inherited from interface org.kurento.client.MediaElement
addElementConnectedListener, addElementConnectedListener, addElementDisconnectedListener, addElementDisconnectedListener, addMediaFlowInStateChangedListener, addMediaFlowInStateChangedListener, addMediaFlowInStateChangeListener, addMediaFlowInStateChangeListener, addMediaFlowOutStateChangedListener, addMediaFlowOutStateChangedListener, addMediaFlowOutStateChangeListener, addMediaFlowOutStateChangeListener, addMediaTranscodingStateChangedListener, addMediaTranscodingStateChangedListener, addMediaTranscodingStateChangeListener, addMediaTranscodingStateChangeListener, connect, connect, connect, connect, connect, connect, connect, connect, connect, connect, connect, connect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, getEncoderBitrate, getEncoderBitrate, getEncoderBitrate, getGstreamerDot, getGstreamerDot, getGstreamerDot, getGstreamerDot, getGstreamerDot, getGstreamerDot, getMaxEncoderBitrate, getMaxEncoderBitrate, getMaxEncoderBitrate, getMinEncoderBitrate, getMinEncoderBitrate, getMinEncoderBitrate, getSinkConnections, getSinkConnections, getSinkConnections, getSinkConnections, getSinkConnections, getSinkConnections, getSinkConnections, getSinkConnections, getSinkConnections, getSourceConnections, getSourceConnections, getSourceConnections, getSourceConnections, getSourceConnections, getSourceConnections, getSourceConnections, getSourceConnections, getSourceConnections, getStats, getStats, getStats, getStats, getStats, getStats, isMediaFlowingIn, isMediaFlowingIn, isMediaFlowingIn, isMediaFlowingIn, isMediaFlowingIn, isMediaFlowingIn, isMediaFlowingOut, isMediaFlowingOut, isMediaFlowingOut, isMediaFlowingOut, isMediaFlowingOut, isMediaFlowingOut, isMediaTranscoding, isMediaTranscoding, isMediaTranscoding, isMediaTranscoding, isMediaTranscoding, isMediaTranscoding, removeElementConnectedListener, removeElementConnectedListener, removeElementDisconnectedListener, removeElementDisconnectedListener, removeMediaFlowInStateChangedListener, removeMediaFlowInStateChangedListener, removeMediaFlowInStateChangeListener, removeMediaFlowInStateChangeListener, removeMediaFlowOutStateChangedListener, removeMediaFlowOutStateChangedListener, removeMediaFlowOutStateChangeListener, removeMediaFlowOutStateChangeListener, removeMediaTranscodingStateChangedListener, removeMediaTranscodingStateChangedListener, removeMediaTranscodingStateChangeListener, removeMediaTranscodingStateChangeListener, setAudioFormat, setAudioFormat, setAudioFormat, setEncoderBitrate, setEncoderBitrate, setEncoderBitrate, setMaxEncoderBitrate, setMaxEncoderBitrate, setMaxEncoderBitrate, setMinEncoderBitrate, setMinEncoderBitrate, setMinEncoderBitrate, setVideoFormat, setVideoFormat, setVideoFormat
-
Methods inherited from interface org.kurento.client.MediaObject
addErrorListener, addErrorListener, addTag, addTag, addTag, getChildren, getChildren, getChildren, getCreationTime, getCreationTime, getCreationTime, getId, getId, getId, getMediaPipeline, getMediaPipeline, getMediaPipeline, getName, getName, getName, getParent, getParent, getParent, getSendTagsInEvents, getSendTagsInEvents, getSendTagsInEvents, getTag, getTag, getTag, getTags, getTags, getTags, removeErrorListener, removeErrorListener, removeTag, removeTag, removeTag, setName, setName, setName, setSendTagsInEvents, setSendTagsInEvents, setSendTagsInEvents
-
-
-
-
Method Detail
-
removeImage
void removeImage(String id)
Remove the image with the given ID.- Parameters:
id
- Image ID to be removed
-
removeImage
void removeImage(String id, Continuation<Void> cont)
Asynchronous version of removeImage:Continuation.onSuccess(F)
is called when the action is done. If an error occurs,Continuation.onError(java.lang.Throwable)
is called.- Parameters:
id
- Image ID to be removed- See Also:
removeImage(java.lang.String)
-
removeImage
void removeImage(Transaction tx, String id)
Remove the image with the given ID.- Parameters:
id
- Image ID to be removed
-
addImage
void addImage(String id, String uri, float offsetXPercent, float offsetYPercent, float widthPercent, float heightPercent, boolean keepAspectRatio, boolean center)
Add an image to be used as overlay.- Parameters:
id
- image IDuri
- URI where the image is locatedoffsetXPercent
- Percentage relative to the image width to calculate the X coordinate of the position (left upper corner) [0..1]offsetYPercent
- Percentage relative to the image height to calculate the Y coordinate of the position (left upper corner) [0..1]widthPercent
- Proportional width of the overlaid image, relative to the width of the video [0..1].heightPercent
- Proportional height of the overlaid image, relative to the height of the video [0..1].keepAspectRatio
- Keep the aspect ratio of the original image.center
- If the image doesn't fit in the dimensions, the image will be center into the region defined by height and width.
-
addImage
void addImage(String id, String uri, float offsetXPercent, float offsetYPercent, float widthPercent, float heightPercent, boolean keepAspectRatio, boolean center, Continuation<Void> cont)
Asynchronous version of addImage:Continuation.onSuccess(F)
is called when the action is done. If an error occurs,Continuation.onError(java.lang.Throwable)
is called.- Parameters:
id
- image IDuri
- URI where the image is locatedoffsetXPercent
- Percentage relative to the image width to calculate the X coordinate of the position (left upper corner) [0..1]offsetYPercent
- Percentage relative to the image height to calculate the Y coordinate of the position (left upper corner) [0..1]widthPercent
- Proportional width of the overlaid image, relative to the width of the video [0..1].heightPercent
- Proportional height of the overlaid image, relative to the height of the video [0..1].keepAspectRatio
- Keep the aspect ratio of the original image.center
- If the image doesn't fit in the dimensions, the image will be center into the region defined by height and width.- See Also:
addImage(java.lang.String, java.lang.String, float, float, float, float, boolean, boolean)
-
addImage
void addImage(Transaction tx, String id, String uri, float offsetXPercent, float offsetYPercent, float widthPercent, float heightPercent, boolean keepAspectRatio, boolean center)
Add an image to be used as overlay.- Parameters:
id
- image IDuri
- URI where the image is locatedoffsetXPercent
- Percentage relative to the image width to calculate the X coordinate of the position (left upper corner) [0..1]offsetYPercent
- Percentage relative to the image height to calculate the Y coordinate of the position (left upper corner) [0..1]widthPercent
- Proportional width of the overlaid image, relative to the width of the video [0..1].heightPercent
- Proportional height of the overlaid image, relative to the height of the video [0..1].keepAspectRatio
- Keep the aspect ratio of the original image.center
- If the image doesn't fit in the dimensions, the image will be center into the region defined by height and width.
-
-