fm.liveswitch.MediaIntent Class Referenceabstract

Represents media intent information for negotiating the intentions of the SDK. More...

Public Member Functions

long getBitrate ()
 Gets the target output bitrate, in kbps. More...
 
boolean getIsVideo ()
 Gets whether this intent is for video media. More...
 
fm.liveswitch.StreamDirection getLocalDirection ()
 Gets the local stream direction. More...
 
String serialize ()
 Serializes the media intent to a string format. More...
 
void setBitrate (long value)
 Sets the target output bitrate, in kbps. More...
 
void setLocalDirection (fm.liveswitch.StreamDirection value)
 Sets the local stream direction. More...
 

Static Public Member Functions

static fm.liveswitch.MediaIntent parse (String media)
 Parses a media intent string into a MediaIntent object. More...
 

Protected Member Functions

 MediaIntent ()
 Initializes a new instance of the MediaIntent class. More...
 
void setIsVideo (boolean value)
 Sets whether this intent is for video media. More...
 

Detailed Description

Represents media intent information for negotiating the intentions of the SDK.

Constructor & Destructor Documentation

◆ MediaIntent()

fm.liveswitch.MediaIntent.MediaIntent ( )
protected

Initializes a new instance of the MediaIntent class.

Member Function Documentation

◆ getBitrate()

long fm.liveswitch.MediaIntent.getBitrate ( )

Gets the target output bitrate, in kbps.

A value of -1 indicates unset (no target).

◆ getIsVideo()

boolean fm.liveswitch.MediaIntent.getIsVideo ( )

Gets whether this intent is for video media.

◆ getLocalDirection()

fm.liveswitch.StreamDirection fm.liveswitch.MediaIntent.getLocalDirection ( )

Gets the local stream direction.

◆ parse()

static fm.liveswitch.MediaIntent fm.liveswitch.MediaIntent.parse ( String  media)
static

Parses a media intent string into a MediaIntent object.

Parameters
mediaThe serialized media intent string.
Returns
A MediaIntent object, or null if parsing fails.

◆ serialize()

String fm.liveswitch.MediaIntent.serialize ( )

Serializes the media intent to a string format.

Returns
Serialized media intent string.

Reimplemented in fm.liveswitch.VideoIntent.

◆ setBitrate()

void fm.liveswitch.MediaIntent.setBitrate ( long  value)

Sets the target output bitrate, in kbps.

A value of -1 indicates unset (no target).

◆ setIsVideo()

void fm.liveswitch.MediaIntent.setIsVideo ( boolean  value)
protected

Sets whether this intent is for video media.

◆ setLocalDirection()

void fm.liveswitch.MediaIntent.setLocalDirection ( fm.liveswitch.StreamDirection  value)

Sets the local stream direction.