fm.liveswitch.sdp.rtp.RidAttribute Class Reference

The SDP media attribute "rid" specifies restrictions defining a unique RTP payload configuration. More...

Public Member Functions

String getDirection ()
 Gets the direction. More...
 
String getId ()
 Gets the identifier. More...
 
int[] getPayloadTypes ()
 Gets the payload types that can be used in the associated stream. More...
 
fm.liveswitch.sdp.rtp.RidRestriction[] getRestrictions ()
 Gets the codec-agnostic restrictions to which the corresponding stream will conform. More...
 
String getRestrictionValue (String restrictionKey)
 Gets a restriction value. More...
 
 RidAttribute (String idValue, String direction)
 Initializes a new instance of the fm.liveswitch.sdp.rtp.RidAttribute class. More...
 
 RidAttribute (String idValue, String direction, int[] payloadTypes)
 Initializes a new instance of the fm.liveswitch.sdp.rtp.RidAttribute class. More...
 
 RidAttribute (String idValue, String direction, int[] payloadTypes, fm.liveswitch.sdp.rtp.RidRestriction[] restrictions)
 Initializes a new instance of the fm.liveswitch.sdp.rtp.RidAttribute class. More...
 
 RidAttribute (String idValue, String direction, fm.liveswitch.sdp.rtp.RidRestriction[] restrictions)
 Initializes a new instance of the fm.liveswitch.sdp.rtp.RidAttribute class. More...
 
void setPayloadTypes (int[] value)
 Sets the payload types that can be used in the associated stream. More...
 
void setRestrictions (fm.liveswitch.sdp.rtp.RidRestriction[] value)
 Sets the codec-agnostic restrictions to which the corresponding stream will conform. More...
 
- Public Member Functions inherited from fm.liveswitch.sdp.Attribute
fm.liveswitch.sdp.AttributeType getAttributeType ()
 Gets this Attribute's Type. More...
 
fm.liveswitch.sdp.AttributeCategory getMultiplexingCategory ()
 Gets the Multiplexing Category of this Attribute. More...
 
void setAttributeType (fm.liveswitch.sdp.AttributeType value)
 Sets this Attribute's Type. More...
 
String toString ()
 Converts this instance to a string. More...
 

Static Public Member Functions

static fm.liveswitch.sdp.rtp.RidAttribute fromAttributeValue (String value)
 Initializes a new instance of the fm.liveswitch.sdp.rtp.RidAttribute class. More...
 
static boolean validateId (String idValue)
 Validates that the identifier conforms to RFC syntax, which means that it only contains alpha-numeric characters and/or the hyphen and underscore. More...
 
- Static Public Member Functions inherited from fm.liveswitch.sdp.Attribute
static fm.liveswitch.sdp.Attribute createAttribute (String name, String value)
 Creates an attribute. More...
 
static String getTypeName (@SuppressWarnings("rawtypes") Class type)
 Gets the name of the attribute type. More...
 
static boolean isMediaLevel (@SuppressWarnings("rawtypes") Class type)
 Determines whether the type applies to media streams. More...
 
static boolean isSessionLevel (@SuppressWarnings("rawtypes") Class type)
 Determines whether the type applies to sessions. More...
 
static fm.liveswitch.sdp.Attribute parse (String s)
 Creates an fm.liveswitch.sdp.ConnectionData instance from a string. More...
 

Protected Member Functions

String getAttributeValue ()
 Gets the internal value of the attribute. More...
 
- Protected Member Functions inherited from fm.liveswitch.sdp.Attribute
 Attribute ()
 
void setMultiplexingCategory (fm.liveswitch.sdp.AttributeCategory value)
 Sets the Multiplexing Category of this Attribute. More...
 

Detailed Description

The SDP media attribute "rid" specifies restrictions defining a unique RTP payload configuration.

Constructor & Destructor Documentation

◆ RidAttribute() [1/4]

fm.liveswitch.sdp.rtp.RidAttribute.RidAttribute ( String  idValue,
String  direction 
)

Initializes a new instance of the fm.liveswitch.sdp.rtp.RidAttribute class.

Parameters
idValueThe identifier.
directionThe direction.

◆ RidAttribute() [2/4]

fm.liveswitch.sdp.rtp.RidAttribute.RidAttribute ( String  idValue,
String  direction,
int[]  payloadTypes 
)

Initializes a new instance of the fm.liveswitch.sdp.rtp.RidAttribute class.

Parameters
idValueThe identifier.
directionThe direction.
payloadTypesThe payload types.

◆ RidAttribute() [3/4]

fm.liveswitch.sdp.rtp.RidAttribute.RidAttribute ( String  idValue,
String  direction,
int[]  payloadTypes,
fm.liveswitch.sdp.rtp.RidRestriction[]  restrictions 
)

Initializes a new instance of the fm.liveswitch.sdp.rtp.RidAttribute class.

Parameters
idValueThe identifier.
directionThe direction.
payloadTypesThe payload types.
restrictionsThe restrictions.

◆ RidAttribute() [4/4]

fm.liveswitch.sdp.rtp.RidAttribute.RidAttribute ( String  idValue,
String  direction,
fm.liveswitch.sdp.rtp.RidRestriction[]  restrictions 
)

Initializes a new instance of the fm.liveswitch.sdp.rtp.RidAttribute class.

Parameters
idValueThe identifier.
directionThe direction.
restrictionsThe restrictions.

Member Function Documentation

◆ fromAttributeValue()

static fm.liveswitch.sdp.rtp.RidAttribute fm.liveswitch.sdp.rtp.RidAttribute.fromAttributeValue ( String  value)
static

Initializes a new instance of the fm.liveswitch.sdp.rtp.RidAttribute class.

Parameters
valueThe attribute value.

◆ getAttributeValue()

String fm.liveswitch.sdp.rtp.RidAttribute.getAttributeValue ( )
protected

Gets the internal value of the attribute.

Reimplemented from fm.liveswitch.sdp.Attribute.

◆ getDirection()

String fm.liveswitch.sdp.rtp.RidAttribute.getDirection ( )

Gets the direction.

◆ getId()

String fm.liveswitch.sdp.rtp.RidAttribute.getId ( )

Gets the identifier.

◆ getPayloadTypes()

int [] fm.liveswitch.sdp.rtp.RidAttribute.getPayloadTypes ( )

Gets the payload types that can be used in the associated stream.

This property is optional and may be null.

◆ getRestrictions()

fm.liveswitch.sdp.rtp.RidRestriction [] fm.liveswitch.sdp.rtp.RidAttribute.getRestrictions ( )

Gets the codec-agnostic restrictions to which the corresponding stream will conform.

This property is optional and may be null.

◆ getRestrictionValue()

String fm.liveswitch.sdp.rtp.RidAttribute.getRestrictionValue ( String  restrictionKey)

Gets a restriction value.

Parameters
restrictionKeyThe restriction key.

◆ setPayloadTypes()

void fm.liveswitch.sdp.rtp.RidAttribute.setPayloadTypes ( int[]  value)

Sets the payload types that can be used in the associated stream.

This property is optional and may be null.

◆ setRestrictions()

void fm.liveswitch.sdp.rtp.RidAttribute.setRestrictions ( fm.liveswitch.sdp.rtp.RidRestriction[]  value)

Sets the codec-agnostic restrictions to which the corresponding stream will conform.

This property is optional and may be null.

◆ validateId()

static boolean fm.liveswitch.sdp.rtp.RidAttribute.validateId ( String  idValue)
static

Validates that the identifier conforms to RFC syntax, which means that it only contains alpha-numeric characters and/or the hyphen and underscore.

See https://tools.ietf.org/html/draft-ietf-avtext-rid/ and https://tools.ietf.org/html/draft-ietf-mmusic-rid/ for more info.

Parameters
idValueThe identifier