fm.liveswitch.MediaStreamInfo Class Reference

Media stream information. More...

Public Member Functions

String getControlTransportId ()
 Gets the control transport id. More...
 
String getDirection ()
 Gets the media stream direction. More...
 
int getLocalBandwidth ()
 Gets the media stream's local bandwidth. More...
 
int getMaxFrameHeight ()
 Gets the media stream's maximum frame height. More...
 
int getMaxFrameWidth ()
 Gets the media stream's maximum frame width. More...
 
String getReceiveContent ()
 Gets the media stream's receive content. More...
 
boolean getReceiveDisabled ()
 Gets whether the media stream has the receive direction disabled. More...
 
fm.liveswitch.EncodingInfo[] getReceiveEncodings ()
 Gets the media stream receive encodings. More...
 
fm.liveswitch.FormatInfo[] getReceiveFormats ()
 Gets the media stream receive formats. More...
 
fm.liveswitch.MediaReceiverInfo getReceiver ()
 Gets the first media stream receiver information. More...
 
fm.liveswitch.MediaReceiverInfo[] getReceivers ()
 Gets the media stream receivers information. More...
 
int getRemoteBandwidth ()
 Gets the media stream's remote bandwidth. More...
 
String getSendContent ()
 Gets the media stream's send content. More...
 
boolean getSendDisabled ()
 Gets whether the media stream has the send direction disabled. More...
 
fm.liveswitch.EncodingInfo[] getSendEncodings ()
 Gets the media stream send encodings. More...
 
fm.liveswitch.MediaSenderInfo getSender ()
 Gets the first media stream sender information. More...
 
fm.liveswitch.MediaSenderInfo[] getSenders ()
 Gets the media stream senders information. More...
 
fm.liveswitch.FormatInfo[] getSendFormats ()
 Gets the media stream send formats. More...
 
boolean getSendMuted ()
 Gets whether the sender is muted. More...
 
boolean getSendUnmuteDisabled ()
 Gets whether the sender cannot be unmuted. More...
 
 MediaStreamInfo ()
 
void setControlTransportId (String value)
 Sets the control transport id. More...
 
void setDirection (String value)
 Sets the media stream direction. More...
 
void setLocalBandwidth (int value)
 Sets the media stream's local bandwidth. More...
 
void setMaxFrameHeight (int value)
 Sets the media stream's maximum frame height. More...
 
void setMaxFrameWidth (int value)
 Sets the media stream's maximum frame width. More...
 
void setReceiveContent (String value)
 Sets the media stream's receive content. More...
 
void setReceiveDisabled (boolean value)
 Sets whether the media stream has the receive direction disabled. More...
 
void setReceiveEncodings (fm.liveswitch.EncodingInfo[] value)
 Sets the media stream receive encodings. More...
 
void setReceiveFormats (fm.liveswitch.FormatInfo[] value)
 Sets the media stream receive formats. More...
 
void setReceivers (fm.liveswitch.MediaReceiverInfo[] value)
 Sets the media stream receivers information. More...
 
void setRemoteBandwidth (int value)
 Sets the media stream's remote bandwidth. More...
 
void setSendContent (String value)
 Sets the media stream's send content. More...
 
void setSendDisabled (boolean value)
 Sets whether the media stream has the send direction disabled. More...
 
void setSendEncodings (fm.liveswitch.EncodingInfo[] value)
 Sets the media stream send encodings. More...
 
void setSenders (fm.liveswitch.MediaSenderInfo[] value)
 Sets the media stream senders information. More...
 
void setSendFormats (fm.liveswitch.FormatInfo[] value)
 Sets the media stream send formats. More...
 
void setSendMuted (boolean value)
 Sets whether the sender is muted. More...
 
void setSendUnmuteDisabled (boolean value)
 Sets whether the sender cannot be unmuted. More...
 
String toJson ()
 Serializes this instance to JSON. More...
 
- Public Member Functions inherited from fm.liveswitch.StreamInfo
String getTag ()
 Gets the tag. More...
 
String getTransportId ()
 Gets the transport id. More...
 
void setTag (String value)
 Sets the tag. More...
 
void setTransportId (String value)
 Sets the transport id. More...
 
- Public Member Functions inherited from fm.liveswitch.Info
String getId ()
 Gets the identifier. More...
 
void setId (String value)
 Sets the identifier. More...
 

Static Public Member Functions

static fm.liveswitch.MediaStreamInfo fromJson (String mediaStreamInfoJson)
 Deserializes an instance from JSON. More...
 
static fm.liveswitch.MediaStreamInfo[] fromJsonArray (String mediaStreamInfosJson)
 Deserializes an array from JSON. More...
 
static String toJson (fm.liveswitch.MediaStreamInfo mediaStreamInfo)
 Serializes an instance to JSON. More...
 
static String toJsonArray (fm.liveswitch.MediaStreamInfo[] mediaStreamInfos)
 Serializes an array to JSON. More...
 
- Static Public Member Functions inherited from fm.liveswitch.Info
static< T extends fm.liveswitch.IEquivalent< T > T[] processArray (T[] newValues, T[] oldValues)
 Processes an array for an info. More...
 
static fm.liveswitch.NullableBoolean processBoolean (boolean newValue, boolean oldValue)
 Processes a boolean for an info. More...
 
static boolean[] processBooleanArray (boolean[] newValues, boolean[] oldValues)
 Processes a boolean array for an info. More...
 
static fm.liveswitch.NullableDouble processDouble (double newValue, double oldValue)
 Processes a double for an info. More...
 
static fm.liveswitch.NullableFloat processFloat (float newValue, float oldValue)
 Processes a float for an info. More...
 
static float[] processFloatArray (float[] newValues, float[] oldValues)
 Processes a float array for an info. More...
 
static double[] processFloatArray (double[] newValues, double[] oldValues)
 Processes a double array for an info. More...
 
static fm.liveswitch.NullableInteger processInteger (int newValue, int oldValue)
 Processes an integer for an info. More...
 
static int[] processIntegerArray (int[] newValues, int[] oldValues)
 Processes a integer array for an info. More...
 
static fm.liveswitch.NullableLong processLong (long newValue, long oldValue)
 Processes a long for an info. More...
 
static long[] processLongArray (long[] newValues, long[] oldValues)
 Processes a long array for an info. More...
 
static< T extends Object &fm.liveswitch.IEquivalent< T > T processObject (T newValue, T oldValue)
 Processes an object for an info. More...
 
static fm.liveswitch.NullableShort processShort (short newValue, short oldValue)
 Processes a short for an info. More...
 
static short[] processShortArray (short[] newValues, short[] oldValues)
 Processes a short array for an info. More...
 
static String processString (String newValue, String oldValue)
 Processes a string for an info. More...
 

Protected Member Functions

void deserializeProperties (String key, String valueJson)
 Deserializes the properties. More...
 
void serializeProperties (java.util.HashMap< String, String > jsonObject)
 Serializes the properties. More...
 
- Protected Member Functions inherited from fm.liveswitch.StreamInfo
 StreamInfo ()
 
- Protected Member Functions inherited from fm.liveswitch.Info
 Info ()
 

Detailed Description

Media stream information.

Constructor & Destructor Documentation

◆ MediaStreamInfo()

fm.liveswitch.MediaStreamInfo.MediaStreamInfo ( )

Member Function Documentation

◆ deserializeProperties()

void fm.liveswitch.MediaStreamInfo.deserializeProperties ( String  key,
String  valueJson 
)
protected

Deserializes the properties.

Parameters
keyThe key.
valueJsonThe value in JSON format.

Reimplemented from fm.liveswitch.StreamInfo.

◆ fromJson()

static fm.liveswitch.MediaStreamInfo fm.liveswitch.MediaStreamInfo.fromJson ( String  mediaStreamInfoJson)
static

Deserializes an instance from JSON.

Parameters
mediaStreamInfoJsonThe serialized JSON.
Returns
The deserialized instance.

◆ fromJsonArray()

static fm.liveswitch.MediaStreamInfo [] fm.liveswitch.MediaStreamInfo.fromJsonArray ( String  mediaStreamInfosJson)
static

Deserializes an array from JSON.

Parameters
mediaStreamInfosJsonThe serialized JSON.
Returns
The deserialized array.

◆ getControlTransportId()

String fm.liveswitch.MediaStreamInfo.getControlTransportId ( )

Gets the control transport id.

This will be

null

if BUNDLE is active.

◆ getDirection()

String fm.liveswitch.MediaStreamInfo.getDirection ( )

Gets the media stream direction.

◆ getLocalBandwidth()

int fm.liveswitch.MediaStreamInfo.getLocalBandwidth ( )

Gets the media stream's local bandwidth.

◆ getMaxFrameHeight()

int fm.liveswitch.MediaStreamInfo.getMaxFrameHeight ( )

Gets the media stream's maximum frame height.

◆ getMaxFrameWidth()

int fm.liveswitch.MediaStreamInfo.getMaxFrameWidth ( )

Gets the media stream's maximum frame width.

◆ getReceiveContent()

String fm.liveswitch.MediaStreamInfo.getReceiveContent ( )

Gets the media stream's receive content.

◆ getReceiveDisabled()

boolean fm.liveswitch.MediaStreamInfo.getReceiveDisabled ( )

Gets whether the media stream has the receive direction disabled.

◆ getReceiveEncodings()

fm.liveswitch.EncodingInfo [] fm.liveswitch.MediaStreamInfo.getReceiveEncodings ( )

Gets the media stream receive encodings.

◆ getReceiveFormats()

fm.liveswitch.FormatInfo [] fm.liveswitch.MediaStreamInfo.getReceiveFormats ( )

Gets the media stream receive formats.

◆ getReceiver()

fm.liveswitch.MediaReceiverInfo fm.liveswitch.MediaStreamInfo.getReceiver ( )

Gets the first media stream receiver information.

◆ getReceivers()

fm.liveswitch.MediaReceiverInfo [] fm.liveswitch.MediaStreamInfo.getReceivers ( )

Gets the media stream receivers information.

◆ getRemoteBandwidth()

int fm.liveswitch.MediaStreamInfo.getRemoteBandwidth ( )

Gets the media stream's remote bandwidth.

◆ getSendContent()

String fm.liveswitch.MediaStreamInfo.getSendContent ( )

Gets the media stream's send content.

◆ getSendDisabled()

boolean fm.liveswitch.MediaStreamInfo.getSendDisabled ( )

Gets whether the media stream has the send direction disabled.

◆ getSendEncodings()

fm.liveswitch.EncodingInfo [] fm.liveswitch.MediaStreamInfo.getSendEncodings ( )

Gets the media stream send encodings.

◆ getSender()

fm.liveswitch.MediaSenderInfo fm.liveswitch.MediaStreamInfo.getSender ( )

Gets the first media stream sender information.

◆ getSenders()

fm.liveswitch.MediaSenderInfo [] fm.liveswitch.MediaStreamInfo.getSenders ( )

Gets the media stream senders information.

◆ getSendFormats()

fm.liveswitch.FormatInfo [] fm.liveswitch.MediaStreamInfo.getSendFormats ( )

Gets the media stream send formats.

◆ getSendMuted()

boolean fm.liveswitch.MediaStreamInfo.getSendMuted ( )

Gets whether the sender is muted.

Returns true if the sender is muted and false otherwise.

◆ getSendUnmuteDisabled()

boolean fm.liveswitch.MediaStreamInfo.getSendUnmuteDisabled ( )

Gets whether the sender cannot be unmuted.

Returns true if the sender cannot be unmuted and false otherwise.

◆ serializeProperties()

void fm.liveswitch.MediaStreamInfo.serializeProperties ( java.util.HashMap< String, String >  jsonObject)
protected

Serializes the properties.

Parameters
jsonObjectThe JSON object.

Reimplemented from fm.liveswitch.StreamInfo.

◆ setControlTransportId()

void fm.liveswitch.MediaStreamInfo.setControlTransportId ( String  value)

Sets the control transport id.

This will be

null

if BUNDLE is active.

◆ setDirection()

void fm.liveswitch.MediaStreamInfo.setDirection ( String  value)

Sets the media stream direction.

◆ setLocalBandwidth()

void fm.liveswitch.MediaStreamInfo.setLocalBandwidth ( int  value)

Sets the media stream's local bandwidth.

◆ setMaxFrameHeight()

void fm.liveswitch.MediaStreamInfo.setMaxFrameHeight ( int  value)

Sets the media stream's maximum frame height.

◆ setMaxFrameWidth()

void fm.liveswitch.MediaStreamInfo.setMaxFrameWidth ( int  value)

Sets the media stream's maximum frame width.

◆ setReceiveContent()

void fm.liveswitch.MediaStreamInfo.setReceiveContent ( String  value)

Sets the media stream's receive content.

◆ setReceiveDisabled()

void fm.liveswitch.MediaStreamInfo.setReceiveDisabled ( boolean  value)

Sets whether the media stream has the receive direction disabled.

◆ setReceiveEncodings()

void fm.liveswitch.MediaStreamInfo.setReceiveEncodings ( fm.liveswitch.EncodingInfo[]  value)

Sets the media stream receive encodings.

◆ setReceiveFormats()

void fm.liveswitch.MediaStreamInfo.setReceiveFormats ( fm.liveswitch.FormatInfo[]  value)

Sets the media stream receive formats.

◆ setReceivers()

void fm.liveswitch.MediaStreamInfo.setReceivers ( fm.liveswitch.MediaReceiverInfo[]  value)

Sets the media stream receivers information.

◆ setRemoteBandwidth()

void fm.liveswitch.MediaStreamInfo.setRemoteBandwidth ( int  value)

Sets the media stream's remote bandwidth.

◆ setSendContent()

void fm.liveswitch.MediaStreamInfo.setSendContent ( String  value)

Sets the media stream's send content.

◆ setSendDisabled()

void fm.liveswitch.MediaStreamInfo.setSendDisabled ( boolean  value)

Sets whether the media stream has the send direction disabled.

◆ setSendEncodings()

void fm.liveswitch.MediaStreamInfo.setSendEncodings ( fm.liveswitch.EncodingInfo[]  value)

Sets the media stream send encodings.

◆ setSenders()

void fm.liveswitch.MediaStreamInfo.setSenders ( fm.liveswitch.MediaSenderInfo[]  value)

Sets the media stream senders information.

◆ setSendFormats()

void fm.liveswitch.MediaStreamInfo.setSendFormats ( fm.liveswitch.FormatInfo[]  value)

Sets the media stream send formats.

◆ setSendMuted()

void fm.liveswitch.MediaStreamInfo.setSendMuted ( boolean  value)

Sets whether the sender is muted.

Returns true if the sender is muted and false otherwise.

◆ setSendUnmuteDisabled()

void fm.liveswitch.MediaStreamInfo.setSendUnmuteDisabled ( boolean  value)

Sets whether the sender cannot be unmuted.

Returns true if the sender cannot be unmuted and false otherwise.

◆ toJson() [1/2]

String fm.liveswitch.MediaStreamInfo.toJson ( )

Serializes this instance to JSON.

◆ toJson() [2/2]

static String fm.liveswitch.MediaStreamInfo.toJson ( fm.liveswitch.MediaStreamInfo  mediaStreamInfo)
static

Serializes an instance to JSON.

Parameters
mediaStreamInfoThe instance to serialize.
Returns
The serialized JSON.

◆ toJsonArray()

static String fm.liveswitch.MediaStreamInfo.toJsonArray ( fm.liveswitch.MediaStreamInfo[]  mediaStreamInfos)
static

Serializes an array to JSON.

Parameters
mediaStreamInfosThe array to serialize.
Returns
The serialized JSON.