public interface ImageOverlayFilter extends Filter
Filter
draws an image in a configured position over a video feed.Modifier and Type | Interface and Description |
---|---|
static class |
ImageOverlayFilter.Builder |
Modifier and Type | Method and 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.
|
addElementConnectedListener, addElementConnectedListener, addElementDisconnectedListener, addElementDisconnectedListener, addMediaFlowInStateChangeListener, addMediaFlowInStateChangeListener, addMediaFlowOutStateChangeListener, addMediaFlowOutStateChangeListener, 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, getGstreamerDot, getGstreamerDot, getGstreamerDot, getGstreamerDot, getGstreamerDot, getGstreamerDot, getMaxOuputBitrate, getMaxOuputBitrate, getMaxOuputBitrate, getMaxOutputBitrate, getMaxOutputBitrate, getMaxOutputBitrate, getMinOuputBitrate, getMinOuputBitrate, getMinOuputBitrate, getMinOutputBitrate, getMinOutputBitrate, getMinOutputBitrate, 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, removeMediaFlowInStateChangeListener, removeMediaFlowInStateChangeListener, removeMediaFlowOutStateChangeListener, removeMediaFlowOutStateChangeListener, removeMediaTranscodingStateChangeListener, removeMediaTranscodingStateChangeListener, setAudioFormat, setAudioFormat, setAudioFormat, setMaxOuputBitrate, setMaxOuputBitrate, setMaxOuputBitrate, setMaxOutputBitrate, setMaxOutputBitrate, setMaxOutputBitrate, setMinOuputBitrate, setMinOuputBitrate, setMinOuputBitrate, setMinOutputBitrate, setMinOutputBitrate, setMinOutputBitrate, setOutputBitrate, setOutputBitrate, setOutputBitrate, setVideoFormat, setVideoFormat, setVideoFormat
addErrorListener, addErrorListener, addTag, addTag, addTag, getChildren, getChildren, getChildren, getChilds, getChilds, getChilds, 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
isCommited, release, release, release, waitCommited, whenCommited, whenCommited
void removeImage(String id)
id
- Image ID to be removedvoid removeImage(String id, Continuation<Void> cont)
Continuation.onSuccess(F)
is called when the action is
done. If an error occurs, Continuation.onError(java.lang.Throwable)
is called.id
- Image ID to be removedremoveImage(java.lang.String)
void removeImage(Transaction tx, String id)
id
- Image ID to be removedvoid addImage(String id, String uri, float offsetXPercent, float offsetYPercent, float widthPercent, float heightPercent, boolean keepAspectRatio, boolean center)
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.void addImage(String id, String uri, float offsetXPercent, float offsetYPercent, float widthPercent, float heightPercent, boolean keepAspectRatio, boolean center, Continuation<Void> cont)
Continuation.onSuccess(F)
is called when the action is
done. If an error occurs, Continuation.onError(java.lang.Throwable)
is called.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(java.lang.String, java.lang.String, float, float, float, float, boolean, boolean)
void addImage(Transaction tx, String id, String uri, float offsetXPercent, float offsetYPercent, float widthPercent, float heightPercent, boolean keepAspectRatio, boolean center)
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.Copyright © 2021 Kurento. All rights reserved.