FMLiveSwitchSdpRtpRidAttribute Class Reference

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

Instance Methods

(NSString *) - direction
 Gets the direction. More...
 
(NSString *) - getAttributeValue
 Gets the internal value of the attribute. More...
 
(NSString *) - getRestrictionValueWithRestrictionKey:
 Gets a restriction value. More...
 
(NSString *) - id
 Gets the identifier. More...
 
(instancetype) - initWithId:direction:
 Initializes a new instance of the FMLiveSwitchSdpRtpRidAttribute class. More...
 
(instancetype) - initWithId:direction:payloadTypes:
 Initializes a new instance of the FMLiveSwitchSdpRtpRidAttribute class. More...
 
(instancetype) - initWithId:direction:payloadTypes:restrictions:
 Initializes a new instance of the FMLiveSwitchSdpRtpRidAttribute class. More...
 
(instancetype) - initWithId:direction:restrictions:
 Initializes a new instance of the FMLiveSwitchSdpRtpRidAttribute class. More...
 
(NSMutableArray *) - payloadTypes
 Gets the payload types that can be used in the associated stream. More...
 
(NSMutableArray *) - restrictions
 Gets the codec-agnostic restrictions to which the corresponding stream will conform. More...
 
(void) - setPayloadTypes:
 Sets the payload types that can be used in the associated stream. More...
 
(void) - setRestrictions:
 Sets the codec-agnostic restrictions to which the corresponding stream will conform. More...
 
- Instance Methods inherited from FMLiveSwitchSdpAttribute
(FMLiveSwitchSdpAttributeType) - attributeType
 Gets this Attribute's Type. More...
 
(NSString *) - description
 Converts this instance to a string. More...
 
(instancetype) - init
 
(FMLiveSwitchSdpAttributeCategory) - multiplexingCategory
 Gets the Multiplexing Category of this Attribute. More...
 
(void) - setAttributeType:
 Sets this Attribute's Type. More...
 
(void) - setMultiplexingCategory:
 Sets the Multiplexing Category of this Attribute. More...
 

Class Methods

(FMLiveSwitchSdpRtpRidAttribute *) + fromAttributeValue:
 Initializes a new instance of the FMLiveSwitchSdpRtpRidAttribute class. More...
 
(FMLiveSwitchSdpRtpRidAttribute *) + ridAttributeWithId:direction:
 Initializes a new instance of the FMLiveSwitchSdpRtpRidAttribute class. More...
 
(FMLiveSwitchSdpRtpRidAttribute *) + ridAttributeWithId:direction:payloadTypes:
 Initializes a new instance of the FMLiveSwitchSdpRtpRidAttribute class. More...
 
(FMLiveSwitchSdpRtpRidAttribute *) + ridAttributeWithId:direction:payloadTypes:restrictions:
 Initializes a new instance of the FMLiveSwitchSdpRtpRidAttribute class. More...
 
(FMLiveSwitchSdpRtpRidAttribute *) + ridAttributeWithId:direction:restrictions:
 Initializes a new instance of the FMLiveSwitchSdpRtpRidAttribute class. More...
 
(bool) + validateId:
 Validates that the identifier conforms to RFC syntax, which means that it only contains alpha-numeric characters and/or the hyphen and underscore. More...
 
- Class Methods inherited from FMLiveSwitchSdpAttribute
(FMLiveSwitchSdpAttribute *) + attribute
 
(FMLiveSwitchSdpAttribute *) + createAttributeWithName:value:
 Creates an attribute. More...
 
(NSString *) + getTypeNameWithType:
 Gets the name of the attribute type. More...
 
(bool) + isMediaLevelWithType:
 Determines whether the type applies to media streams. More...
 
(bool) + isSessionLevelWithType:
 Determines whether the type applies to sessions. More...
 
(FMLiveSwitchSdpAttribute *) + parseWithS:
 Creates an FMLiveSwitchSdpConnectionData instance from a string. More...
 

Detailed Description

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

Method Documentation

◆ direction

- (NSString*) direction

Gets the direction.

◆ fromAttributeValue:

+ (FMLiveSwitchSdpRtpRidAttribute*) fromAttributeValue: (NSString *)  value

Initializes a new instance of the FMLiveSwitchSdpRtpRidAttribute class.

Parameters
valueThe attribute value.

◆ getAttributeValue

- (NSString*) getAttributeValue

Gets the internal value of the attribute.

Implements FMLiveSwitchSdpAttribute.

◆ getRestrictionValueWithRestrictionKey:

- (NSString*) getRestrictionValueWithRestrictionKey: (NSString *)  restrictionKey

Gets a restriction value.

Parameters
restrictionKeyThe restriction key.

◆ id

- (NSString*) id

Gets the identifier.

◆ initWithId:direction:

- (instancetype) initWithId: (NSString *)  idValue
direction: (NSString *)  direction 

Initializes a new instance of the FMLiveSwitchSdpRtpRidAttribute class.

Parameters
idValueThe identifier.
directionThe direction.

◆ initWithId:direction:payloadTypes:

- (instancetype) initWithId: (NSString *)  idValue
direction: (NSString *)  direction
payloadTypes: (NSMutableArray *)  payloadTypes 

Initializes a new instance of the FMLiveSwitchSdpRtpRidAttribute class.

Parameters
idValueThe identifier.
directionThe direction.
payloadTypesThe payload types.

◆ initWithId:direction:payloadTypes:restrictions:

- (instancetype) initWithId: (NSString *)  idValue
direction: (NSString *)  direction
payloadTypes: (NSMutableArray *)  payloadTypes
restrictions: (NSMutableArray *)  restrictions 

Initializes a new instance of the FMLiveSwitchSdpRtpRidAttribute class.

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

◆ initWithId:direction:restrictions:

- (instancetype) initWithId: (NSString *)  idValue
direction: (NSString *)  direction
restrictions: (NSMutableArray *)  restrictions 

Initializes a new instance of the FMLiveSwitchSdpRtpRidAttribute class.

Parameters
idValueThe identifier.
directionThe direction.
restrictionsThe restrictions.

◆ payloadTypes

- (NSMutableArray*) payloadTypes

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

This property is optional and may be null.

◆ restrictions

- (NSMutableArray*) restrictions

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

This property is optional and may be null.

◆ ridAttributeWithId:direction:

+ (FMLiveSwitchSdpRtpRidAttribute*) ridAttributeWithId: (NSString *)  idValue
direction: (NSString *)  direction 

Initializes a new instance of the FMLiveSwitchSdpRtpRidAttribute class.

Parameters
idValueThe identifier.
directionThe direction.

◆ ridAttributeWithId:direction:payloadTypes:

+ (FMLiveSwitchSdpRtpRidAttribute*) ridAttributeWithId: (NSString *)  idValue
direction: (NSString *)  direction
payloadTypes: (NSMutableArray *)  payloadTypes 

Initializes a new instance of the FMLiveSwitchSdpRtpRidAttribute class.

Parameters
idValueThe identifier.
directionThe direction.
payloadTypesThe payload types.

◆ ridAttributeWithId:direction:payloadTypes:restrictions:

+ (FMLiveSwitchSdpRtpRidAttribute*) ridAttributeWithId: (NSString *)  idValue
direction: (NSString *)  direction
payloadTypes: (NSMutableArray *)  payloadTypes
restrictions: (NSMutableArray *)  restrictions 

Initializes a new instance of the FMLiveSwitchSdpRtpRidAttribute class.

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

◆ ridAttributeWithId:direction:restrictions:

+ (FMLiveSwitchSdpRtpRidAttribute*) ridAttributeWithId: (NSString *)  idValue
direction: (NSString *)  direction
restrictions: (NSMutableArray *)  restrictions 

Initializes a new instance of the FMLiveSwitchSdpRtpRidAttribute class.

Parameters
idValueThe identifier.
directionThe direction.
restrictionsThe restrictions.

◆ setPayloadTypes:

- (void) setPayloadTypes: (NSMutableArray *)  value

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

This property is optional and may be null.

◆ setRestrictions:

- (void) setRestrictions: (NSMutableArray *)  value

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

This property is optional and may be null.

◆ validateId:

+ (bool) validateId: (NSString *)  idValue

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