fm.liveswitch.VideoEncodingConfig Class Reference

Video encoding configuration. More...

Public Member Functions

double getFrameRate ()
 Gets the frame-rate, in fps. More...
 
double getScale ()
 Gets the target scale. More...
 
void setFrameRate (double value)
 Sets the frame-rate, in fps. More...
 
void setScale (double value)
 Sets the target scale. More...
 
String toJson ()
 Serializes this instance to JSON. More...
 
String toString ()
 Returns a string that represents this instance. More...
 
 VideoEncodingConfig ()
 Initializes a new instance of the fm.liveswitch.VideoEncodingConfig class. More...
 
 VideoEncodingConfig (fm.liveswitch.EncodingInfo encoding)
 Initializes a new instance of the fm.liveswitch.VideoEncodingConfig class. More...
 
- Public Member Functions inherited from fm.liveswitch.EncodingConfig
 EncodingConfig ()
 Initializes a new instance of the fm.liveswitch.EncodingConfig class. More...
 
 EncodingConfig (fm.liveswitch.EncodingInfo encoding)
 Initializes a new instance of the fm.liveswitch.EncodingConfig class. More...
 
int getBitrate ()
 Gets the bitrate, in kbps. More...
 
boolean getDeactivated ()
 Gets whether this encoding is deactivated. More...
 
String getRtpStreamId ()
 Gets the RTP stream identifier. More...
 
long getSynchronizationSource ()
 Gets the synchronization source. More...
 
void setBitrate (int value)
 Sets the bitrate, in kbps. More...
 
void setDeactivated (boolean value)
 Sets whether this encoding is deactivated. More...
 

Static Public Member Functions

static fm.liveswitch.VideoEncodingConfig fromJson (String encodingConfigJson)
 Deserializes an instance from JSON. More...
 
static fm.liveswitch.VideoEncodingConfig[] fromJsonArray (String encodingConfigsJson)
 Deserializes an array from JSON. More...
 
static String toJson (fm.liveswitch.VideoEncodingConfig encodingConfig)
 Serializes an instance to JSON. More...
 
static String toJsonArray (fm.liveswitch.VideoEncodingConfig[] encodingConfigs)
 Serializes an array to JSON. 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...
 

Detailed Description

Video encoding configuration.

Constructor & Destructor Documentation

◆ VideoEncodingConfig() [1/2]

fm.liveswitch.VideoEncodingConfig.VideoEncodingConfig ( )

Initializes a new instance of the fm.liveswitch.VideoEncodingConfig class.

◆ VideoEncodingConfig() [2/2]

fm.liveswitch.VideoEncodingConfig.VideoEncodingConfig ( fm.liveswitch.EncodingInfo  encoding)

Initializes a new instance of the fm.liveswitch.VideoEncodingConfig class.

Parameters
encodingThe encoding.

Member Function Documentation

◆ deserializeProperties()

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

Deserializes the properties.

Parameters
keyThe key.
valueJsonThe value in JSON format.

Reimplemented from fm.liveswitch.EncodingConfig.

◆ fromJson()

static fm.liveswitch.VideoEncodingConfig fm.liveswitch.VideoEncodingConfig.fromJson ( String  encodingConfigJson)
static

Deserializes an instance from JSON.

Parameters
encodingConfigJsonThe serialized JSON.
Returns
The deserialized instance.

◆ fromJsonArray()

static fm.liveswitch.VideoEncodingConfig [] fm.liveswitch.VideoEncodingConfig.fromJsonArray ( String  encodingConfigsJson)
static

Deserializes an array from JSON.

Parameters
encodingConfigsJsonThe serialized JSON.
Returns
The deserialized array.

◆ getFrameRate()

double fm.liveswitch.VideoEncodingConfig.getFrameRate ( )

Gets the frame-rate, in fps.

◆ getScale()

double fm.liveswitch.VideoEncodingConfig.getScale ( )

Gets the target scale.

◆ serializeProperties()

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

Serializes the properties.

Parameters
jsonObjectThe JSON object.

Reimplemented from fm.liveswitch.EncodingConfig.

◆ setFrameRate()

void fm.liveswitch.VideoEncodingConfig.setFrameRate ( double  value)

Sets the frame-rate, in fps.

◆ setScale()

void fm.liveswitch.VideoEncodingConfig.setScale ( double  value)

Sets the target scale.

◆ toJson() [1/2]

String fm.liveswitch.VideoEncodingConfig.toJson ( )

Serializes this instance to JSON.

◆ toJson() [2/2]

static String fm.liveswitch.VideoEncodingConfig.toJson ( fm.liveswitch.VideoEncodingConfig  encodingConfig)
static

Serializes an instance to JSON.

Parameters
encodingConfigThe instance to serialize.
Returns
The serialized JSON.

◆ toJsonArray()

static String fm.liveswitch.VideoEncodingConfig.toJsonArray ( fm.liveswitch.VideoEncodingConfig[]  encodingConfigs)
static

Serializes an array to JSON.

Parameters
encodingConfigsThe array to serialize.
Returns
The serialized JSON.

◆ toString()

String fm.liveswitch.VideoEncodingConfig.toString ( )

Returns a string that represents this instance.

Returns
A string that represents this instance.