FMLiveSwitchMediaFormat Class Reference

A media format. More...

Instance Methods

(TFormat) - clone
 Clones this instance. More...
 
(TFormat) - createInstance
 Creates a new instance. More...
 
(NSString *) - description
 Returns a string that represents this instance. More...
 
(NSString *) - fullName
 Gets the full name, including clock rate and encoding parameters. More...
 
(NSString *) - getMaxLevelWithLevel1:level2:
 Gets the maximum level. More...
 
(NSString *) - getMinLevelWithLevel1:level2:
 Gets the minimum level. More...
 
(FMLiveSwitchFormatInfo *) - info
 Gets this format as an info object. More...
 
(instancetype) - init
 Initializes a new instance of the FMLiveSwitchMediaFormat`1 class. More...
 
(instancetype) - initWithName:clockRate:
 Initializes a new instance of the FMLiveSwitchMediaFormat`1 class. More...
 
(instancetype) - initWithName:clockRate:packetizationMode:
 Initializes a new instance of the FMLiveSwitchMediaFormat`1 class. More...
 
(instancetype) - initWithName:clockRate:profile:level:
 Initializes a new instance of the FMLiveSwitchMediaFormat`1 class. More...
 
(instancetype) - initWithName:clockRate:profile:level:packetizationMode:
 Initializes a new instance of the FMLiveSwitchMediaFormat`1 class. More...
 
(instancetype) - initWithName:clockRate:profile:level:packetizationMode:tier:
 Initializes a new instance of the FMLiveSwitchMediaFormat`1 class. More...
 
(bool) - isCompatibleWithFormat:
 Determines whether the specified format is compatible. More...
 
(bool) - isCompressed
 Gets whether this is a compressed format. More...
 
(bool) - isEncrypted
 Gets a value indicating that the data is encrypted. More...
 
(bool) - isEquivalentWithFormat:
 Determines whether the specified format is equivalent. More...
 
(bool) - isEquivalentWithFormat:ignoreIsPacketized:
 Determines whether the specified format is equivalent. More...
 
(bool) - isFixedBitrate
 Gets a value indicating whether a format only supports fixed bitrate. More...
 
(bool) - isInjected
 Gets a value indicating that the data is injected into the primary media stream (e.g. More...
 
(bool) - isLevelCompatibleWithLevel:
 Gets whether a level is compatible. More...
 
(bool) - isPacketized
 Gets a value indicating whether the data is packetized. More...
 
(bool) - isProfileCompatibleWithProfile:
 Gets whether a profile is compatible. More...
 
(NSString *) - level
 Gets the level. More...
 
(bool) - levelIsStrict
 Gets a value indicating whether the level is strict. More...
 
(int) - maxBitrate
 Gets the maximum bitrate supported by this format, in kbps. More...
 
(int) - minBitrate
 Gets the minimum bitrate supported by this format, in kbps. More...
 
(NSString *) - name
 Gets the name. More...
 
(NSString *) - packetizationMode
 Gets the packetization mode. More...
 
(NSString *) - parameters
 Gets the parameters. More...
 
(NSString *) - profile
 Gets the profile. More...
 
(void) - setClockRate:
 Sets the clock rate. More...
 
(void) - setIsEncrypted:
 Sets a value indicating that the data is encrypted. More...
 
(void) - setIsFixedBitrate:
 Sets a value indicating whether a format only supports fixed bitrate. More...
 
(void) - setIsInjected:
 Sets a value indicating that the data is injected into the primary media stream (e.g. More...
 
(void) - setIsPacketized:
 Sets a value indicating whether the data is packetized. More...
 
(void) - setLevel:
 Sets the level. More...
 
(void) - setLevelIsStrict:
 Sets a value indicating whether the level is strict. More...
 
(void) - setName:
 Sets the name. More...
 
(void) - setPacketizationMode:
 Sets the packetization mode. More...
 
(void) - setProfile:
 Sets the profile. More...
 
(void) - setStaticPayloadType:
 Sets the static payload type, if this format has a static payload type registered with IANA. More...
 
(void) - setTier:
 Sets the tier. More...
 
(int) - staticPayloadType
 Gets the static payload type, if this format has a static payload type registered with IANA. More...
 
(NSString *) - tier
 Gets the tier. More...
 
(void) - updateLevelIsStrictToCompatibleWithFormat:
 Updates the level-is-strict flag to a compatible value. More...
 
(void) - updateLevelToCompatibleWithFormat:
 Updates the level to a compatible value. More...
 
(void) - updateProfileToCompatibleWithFormat:
 Updates the profile to a compatible value. More...
 
(void) - updateTierToCompatibleWithFormat:
 Updates the tier to a compatible value. More...
 

Class Methods

(FMLiveSwitchMediaFormat *) + mediaFormat
 Initializes a new instance of the FMLiveSwitchMediaFormat`1 class. More...
 
(FMLiveSwitchMediaFormat *) + mediaFormatWithName:clockRate:
 Initializes a new instance of the FMLiveSwitchMediaFormat`1 class. More...
 
(FMLiveSwitchMediaFormat *) + mediaFormatWithName:clockRate:packetizationMode:
 Initializes a new instance of the FMLiveSwitchMediaFormat`1 class. More...
 
(FMLiveSwitchMediaFormat *) + mediaFormatWithName:clockRate:profile:level:
 Initializes a new instance of the FMLiveSwitchMediaFormat`1 class. More...
 
(FMLiveSwitchMediaFormat *) + mediaFormatWithName:clockRate:profile:level:packetizationMode:
 Initializes a new instance of the FMLiveSwitchMediaFormat`1 class. More...
 
(FMLiveSwitchMediaFormat *) + mediaFormatWithName:clockRate:profile:level:packetizationMode:tier:
 Initializes a new instance of the FMLiveSwitchMediaFormat`1 class. More...
 
(NSString *) + redName
 Gets the name of the RED media format. More...
 
(NSString *) + ulpFecName
 Gets the name of the ULPFEC media format. More...
 

Protected Attributes

 __pad0__: NSObject- (int) clockRate
 

Detailed Description

A media format.

Method Documentation

◆ clone

- (TFormat) clone

Clones this instance.

Implemented in FMLiveSwitchVideoFormat, and FMLiveSwitchAudioFormat.

◆ createInstance

◆ description

- (NSString*) description

Returns a string that represents this instance.

◆ fullName

- (NSString*) fullName

Gets the full name, including clock rate and encoding parameters.

◆ getMaxLevelWithLevel1:level2:

- (NSString*) getMaxLevelWithLevel1: (NSString *)  level1
level2: (NSString *)  level2 

Gets the maximum level.

Parameters
level1The first level.
level2The second level.
Returns
The maximum level.

Implemented in FMLiveSwitchVideoFormat.

◆ getMinLevelWithLevel1:level2:

- (NSString*) getMinLevelWithLevel1: (NSString *)  level1
level2: (NSString *)  level2 

Gets the minimum level.

Parameters
level1The first level.
level2The second level.
Returns
The minimum level.

Implemented in FMLiveSwitchVideoFormat.

◆ info

Gets this format as an info object.

Implemented in FMLiveSwitchVideoFormat, and FMLiveSwitchAudioFormat.

◆ init

◆ initWithName:clockRate:

- (instancetype) initWithName: (NSString *)  name
clockRate: (int)  clockRate 

Initializes a new instance of the FMLiveSwitchMediaFormat`1 class.

Parameters
nameThe name.
clockRateThe clock rate.

Implemented in FMLiveSwitchVideoFormat.

◆ initWithName:clockRate:packetizationMode:

- (instancetype) initWithName: (NSString *)  name
clockRate: (int)  clockRate
packetizationMode: (NSString *)  packetizationMode 

Initializes a new instance of the FMLiveSwitchMediaFormat`1 class.

Parameters
nameThe name.
clockRateThe clock rate.
packetizationModeThe packetization mode.

Implemented in FMLiveSwitchVideoFormat.

◆ initWithName:clockRate:profile:level:

- (instancetype) initWithName: (NSString *)  name
clockRate: (int)  clockRate
profile: (NSString *)  profile
level: (NSString *)  level 

Initializes a new instance of the FMLiveSwitchMediaFormat`1 class.

Parameters
nameThe name.
clockRateThe clock rate.
levelThe media format level.
profileThe media format profile.

Implemented in FMLiveSwitchVideoFormat.

◆ initWithName:clockRate:profile:level:packetizationMode:

- (instancetype) initWithName: (NSString *)  name
clockRate: (int)  clockRate
profile: (NSString *)  profile
level: (NSString *)  level
packetizationMode: (NSString *)  packetizationMode 

Initializes a new instance of the FMLiveSwitchMediaFormat`1 class.

Parameters
nameThe name.
clockRateThe clock rate.
levelThe media format level
profileThe media format profile
packetizationModeThe packetization mode.

Implemented in FMLiveSwitchVideoFormat.

◆ initWithName:clockRate:profile:level:packetizationMode:tier:

- (instancetype) initWithName: (NSString *)  name
clockRate: (int)  clockRate
profile: (NSString *)  profile
level: (NSString *)  level
packetizationMode: (NSString *)  packetizationMode
tier: (NSString *)  tier 

Initializes a new instance of the FMLiveSwitchMediaFormat`1 class.

Parameters
nameThe name.
clockRateThe clock rate.
levelThe media format level
profileThe media format profile
packetizationModeThe packetization mode.
tierThe media format tier.

Implemented in FMLiveSwitchVideoFormat.

◆ isCompatibleWithFormat:

- (bool) isCompatibleWithFormat: (TFormat)  format

Determines whether the specified format is compatible.

Parameters
formatThe format.

◆ isCompressed

- (bool) isCompressed

Gets whether this is a compressed format.

Implemented in FMLiveSwitchVideoFormat, and FMLiveSwitchAudioFormat.

◆ isEncrypted

- (bool) isEncrypted

Gets a value indicating that the data is encrypted.

◆ isEquivalentWithFormat:

- (bool) isEquivalentWithFormat: (TFormat)  format

Determines whether the specified format is equivalent.

Parameters
formatThe format.

◆ isEquivalentWithFormat:ignoreIsPacketized:

- (bool) isEquivalentWithFormat: (TFormat)  format
ignoreIsPacketized: (bool)  ignoreIsPacketized 

Determines whether the specified format is equivalent.

Parameters
formatThe format.
ignoreIsPacketizedWhether to ignore if the two formats differ in whether they are packetized.

◆ isFixedBitrate

- (bool) isFixedBitrate

Gets a value indicating whether a format only supports fixed bitrate.

◆ isInjected

- (bool) isInjected

Gets a value indicating that the data is injected into the primary media stream (e.g.

DTMF).

◆ isLevelCompatibleWithLevel:

- (bool) isLevelCompatibleWithLevel: (NSString *)  level

Gets whether a level is compatible.

Parameters
levelThe level.

Implemented in FMLiveSwitchVideoFormat.

◆ isPacketized

- (bool) isPacketized

Gets a value indicating whether the data is packetized.

◆ isProfileCompatibleWithProfile:

- (bool) isProfileCompatibleWithProfile: (NSString *)  profile

Gets whether a profile is compatible.

Parameters
profileThe profile.

Implemented in FMLiveSwitchVideoFormat.

◆ level

- (NSString*) level

Gets the level.

◆ levelIsStrict

- (bool) levelIsStrict

Gets a value indicating whether the level is strict.

◆ maxBitrate

- (int) maxBitrate

◆ mediaFormat

+ (FMLiveSwitchMediaFormat*) mediaFormat

Initializes a new instance of the FMLiveSwitchMediaFormat`1 class.

◆ mediaFormatWithName:clockRate:

+ (FMLiveSwitchMediaFormat*) mediaFormatWithName: (NSString *)  name
clockRate: (int)  clockRate 

Initializes a new instance of the FMLiveSwitchMediaFormat`1 class.

Parameters
nameThe name.
clockRateThe clock rate.

◆ mediaFormatWithName:clockRate:packetizationMode:

+ (FMLiveSwitchMediaFormat*) mediaFormatWithName: (NSString *)  name
clockRate: (int)  clockRate
packetizationMode: (NSString *)  packetizationMode 

Initializes a new instance of the FMLiveSwitchMediaFormat`1 class.

Parameters
nameThe name.
clockRateThe clock rate.
packetizationModeThe packetization mode.

◆ mediaFormatWithName:clockRate:profile:level:

+ (FMLiveSwitchMediaFormat*) mediaFormatWithName: (NSString *)  name
clockRate: (int)  clockRate
profile: (NSString *)  profile
level: (NSString *)  level 

Initializes a new instance of the FMLiveSwitchMediaFormat`1 class.

Parameters
nameThe name.
clockRateThe clock rate.
levelThe media format level.
profileThe media format profile.

◆ mediaFormatWithName:clockRate:profile:level:packetizationMode:

+ (FMLiveSwitchMediaFormat*) mediaFormatWithName: (NSString *)  name
clockRate: (int)  clockRate
profile: (NSString *)  profile
level: (NSString *)  level
packetizationMode: (NSString *)  packetizationMode 

Initializes a new instance of the FMLiveSwitchMediaFormat`1 class.

Parameters
nameThe name.
clockRateThe clock rate.
levelThe media format level
profileThe media format profile
packetizationModeThe packetization mode.

◆ mediaFormatWithName:clockRate:profile:level:packetizationMode:tier:

+ (FMLiveSwitchMediaFormat*) mediaFormatWithName: (NSString *)  name
clockRate: (int)  clockRate
profile: (NSString *)  profile
level: (NSString *)  level
packetizationMode: (NSString *)  packetizationMode
tier: (NSString *)  tier 

Initializes a new instance of the FMLiveSwitchMediaFormat`1 class.

Parameters
nameThe name.
clockRateThe clock rate.
levelThe media format level
profileThe media format profile
packetizationModeThe packetization mode.
tierThe media format tier.

◆ minBitrate

- (int) minBitrate

◆ name

- (NSString*) name

Gets the name.

◆ packetizationMode

- (NSString*) packetizationMode

Gets the packetization mode.

◆ parameters

- (NSString*) parameters

Gets the parameters.

Implemented in FMLiveSwitchVideoFormat, and FMLiveSwitchAudioFormat.

◆ profile

- (NSString*) profile

Gets the profile.

◆ redName

+ (NSString*) redName

Gets the name of the RED media format.

◆ setClockRate:

- (void) setClockRate: (int)  value

Sets the clock rate.

◆ setIsEncrypted:

- (void) setIsEncrypted: (bool)  value

Sets a value indicating that the data is encrypted.

◆ setIsFixedBitrate:

- (void) setIsFixedBitrate: (bool)  value

Sets a value indicating whether a format only supports fixed bitrate.

◆ setIsInjected:

- (void) setIsInjected: (bool)  value

Sets a value indicating that the data is injected into the primary media stream (e.g.

DTMF).

◆ setIsPacketized:

- (void) setIsPacketized: (bool)  value

Sets a value indicating whether the data is packetized.

◆ setLevel:

- (void) setLevel: (NSString *)  value

Sets the level.

◆ setLevelIsStrict:

- (void) setLevelIsStrict: (bool)  value

Sets a value indicating whether the level is strict.

◆ setName:

- (void) setName: (NSString *)  value

Sets the name.

◆ setPacketizationMode:

- (void) setPacketizationMode: (NSString *)  value

Sets the packetization mode.

◆ setProfile:

- (void) setProfile: (NSString *)  value

Sets the profile.

◆ setStaticPayloadType:

- (void) setStaticPayloadType: (int)  value

Sets the static payload type, if this format has a static payload type registered with IANA.

◆ setTier:

- (void) setTier: (NSString *)  value

Sets the tier.

◆ staticPayloadType

- (int) staticPayloadType

Gets the static payload type, if this format has a static payload type registered with IANA.

◆ tier

- (NSString*) tier

Gets the tier.

◆ ulpFecName

+ (NSString*) ulpFecName

Gets the name of the ULPFEC media format.

◆ updateLevelIsStrictToCompatibleWithFormat:

- (void) updateLevelIsStrictToCompatibleWithFormat: (TFormat)  format

Updates the level-is-strict flag to a compatible value.

Parameters
formatThe format.

◆ updateLevelToCompatibleWithFormat:

- (void) updateLevelToCompatibleWithFormat: (TFormat)  format

Updates the level to a compatible value.

Parameters
formatThe format.

◆ updateProfileToCompatibleWithFormat:

- (void) updateProfileToCompatibleWithFormat: (TFormat)  format

Updates the profile to a compatible value.

Parameters
formatThe format.

◆ updateTierToCompatibleWithFormat:

- (void) updateTierToCompatibleWithFormat: (TFormat)  format

Updates the tier to a compatible value.

Parameters
formatThe format.

Member Data Documentation

◆ __pad0__

- __pad0__
protected