org.kurento.client

Interface AlphaBlending

All Superinterfaces:

Hub, KurentoObject, MediaObject

public interface AlphaBlending
extends Hub

A Hub that mixes the #MediaType.AUDIO stream of its connected sources and constructs one output with #MediaType.VIDEO streams of its connected sources into its sink

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	AlphaBlending.Builder

Method Summary

Methods

Modifier and Type	Method and Description
void	setMaster(HubPort source, int zOrder) Sets the source port that will be the master entry to the mixer
void	setMaster(HubPort source, int zOrder, Continuation<Void> cont) Asynchronous version of setMaster: Continuation.onSuccess(F) is called when the action is done.
void	setMaster(Transaction tx, HubPort source, int zOrder) Sets the source port that will be the master entry to the mixer
void	setPortProperties(float relativeX, float relativeY, int zOrder, float relativeWidth, float relativeHeight, HubPort port) Configure the blending mode of one port.
void	setPortProperties(float relativeX, float relativeY, int zOrder, float relativeWidth, float relativeHeight, HubPort port, Continuation<Void> cont) Asynchronous version of setPortProperties: Continuation.onSuccess(F) is called when the action is done.
void	setPortProperties(Transaction tx, float relativeX, float relativeY, int zOrder, float relativeWidth, float relativeHeight, HubPort port) Configure the blending mode of one port.

Methods inherited from interface org.kurento.client.Hub

getGstreamerDot, getGstreamerDot, getGstreamerDot, getGstreamerDot, getGstreamerDot, getGstreamerDot

Methods inherited from interface org.kurento.client.MediaObject

addErrorListener, addErrorListener, addTag, addTag, addTag, 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

Methods inherited from interface org.kurento.client.KurentoObject

isCommited, release, release, release, waitCommited, whenCommited, whenCommited

Method Detail

setMaster

void setMaster(HubPort source,
             int zOrder)

Sets the source port that will be the master entry to the mixer

Parameters:

source - The reference to the HubPort setting as master port

zOrder - The order in z to draw the master image

setMaster

void setMaster(HubPort source,
             int zOrder,
             Continuation<Void> cont)

Asynchronous version of setMaster: Continuation.onSuccess(F) is called when the action is done. If an error occurs, Continuation.onError(java.lang.Throwable) is called.

Parameters:

source - The reference to the HubPort setting as master port

zOrder - The order in z to draw the master image

See Also:

setMaster(org.kurento.client.HubPort, int)

setMaster

void setMaster(Transaction tx,
             HubPort source,
             int zOrder)

Sets the source port that will be the master entry to the mixer

Parameters:

source - The reference to the HubPort setting as master port

zOrder - The order in z to draw the master image

setPortProperties

void setPortProperties(float relativeX,
                     float relativeY,
                     int zOrder,
                     float relativeWidth,
                     float relativeHeight,
                     HubPort port)

Configure the blending mode of one port.

Parameters:

relativeX - The x position relative to the master port. Values from 0 to 1 are accepted. The value 0, indicates the coordinate 0 in the master image.

relativeY - The y position relative to the master port. Values from 0 to 1 are accepted. The value 0, indicates the coordinate 0 in the master image.

zOrder - The order in z to draw the images. The greatest value of z is in the top.

relativeWidth - The image width relative to the master port width. Values from 0 to 1 are accepted.

relativeHeight - The image height relative to the master port height. Values from 0 to 1 are accepted.

port - The reference to the confingured port.

setPortProperties

void setPortProperties(float relativeX,
                     float relativeY,
                     int zOrder,
                     float relativeWidth,
                     float relativeHeight,
                     HubPort port,
                     Continuation<Void> cont)

Asynchronous version of setPortProperties: Continuation.onSuccess(F) is called when the action is done. If an error occurs, Continuation.onError(java.lang.Throwable) is called.

Parameters:

relativeX - The x position relative to the master port. Values from 0 to 1 are accepted. The value 0, indicates the coordinate 0 in the master image.

relativeY - The y position relative to the master port. Values from 0 to 1 are accepted. The value 0, indicates the coordinate 0 in the master image.

zOrder - The order in z to draw the images. The greatest value of z is in the top.

relativeWidth - The image width relative to the master port width. Values from 0 to 1 are accepted.

relativeHeight - The image height relative to the master port height. Values from 0 to 1 are accepted.

port - The reference to the confingured port.

See Also:

setPortProperties(float, float, int, float, float, org.kurento.client.HubPort)

setPortProperties

void setPortProperties(Transaction tx,
                     float relativeX,
                     float relativeY,
                     int zOrder,
                     float relativeWidth,
                     float relativeHeight,
                     HubPort port)

Configure the blending mode of one port.

Parameters:

relativeX - The x position relative to the master port. Values from 0 to 1 are accepted. The value 0, indicates the coordinate 0 in the master image.

relativeY - The y position relative to the master port. Values from 0 to 1 are accepted. The value 0, indicates the coordinate 0 in the master image.

zOrder - The order in z to draw the images. The greatest value of z is in the top.

relativeWidth - The image width relative to the master port width. Values from 0 to 1 are accepted.

relativeHeight - The image height relative to the master port height. Values from 0 to 1 are accepted.

port - The reference to the confingured port.