CPCodecToReplace

Objective-C

@interface CPCodecToReplace : NSObject

Swift

class CPCodecToReplace : NSObject

@brief This is the model class to set the custom payload numbers to given codecs in SDP.

@since 1.4.0

  • Unavailable

    Use one of the static create methods

    Undocumented

    Declaration

    Objective-C

    - (nonnull id) init __attribute__((unavailable("Use one of the static create methods")));

  • Constructor for CodecToReplace class

    @remark If the payload number not set in the range @b 96-127, a @b nil object will return. @since 1.4.0

    Declaration

    Objective-C

    + (nullable CPCodecToReplace *)
    createWithCodecDefinition:(NSString *_Nonnull)codecDefinition
             andPayloadNumber:(NSString *_Nonnull)payloadNumber;

    Swift

    class func create(withCodecDefinition codecDefinition: String, andPayloadNumber payloadNumber: String) -> CPCodecToReplace?

    Parameters

    codecDefinition

    the codec that will be changed
    payloadNumber

    new payload number that will be assigned to the codec, as described in RFC5761 this should be chosen from the range 96-127.

  • Constructor for CodecToReplace class

    @remark If the payload number not set in the range @b 96-127, a @b nil object will return. @since 1.4.0

    Declaration

    Objective-C

    + (nullable CPCodecToReplace *)
    createWithCodecDefinition:(NSString *_Nonnull)codecDefinition
                payloadNumber:(NSString *_Nonnull)payloadNumber
          andCustomProperties:
              (NSDictionary<NSString *, NSString *> *_Nullable)customProperties;

    Swift

    class func create(withCodecDefinition codecDefinition: String, payloadNumber: String, andCustomProperties customProperties: [String : String]?) -> CPCodecToReplace?

    Parameters

    codecDefinition

    the codec that will be changed
    payloadNumber

    new payload number that will be assigned to the codec, as described in RFC5761 this should be chosen from the range 96-127.
    customProperties

    properties of the codec that should be matched to original codec in order SDK to make the replace

  • Returns Codec Definition

    Declaration

    Objective-C

    @property (nonatomic, readonly, nonnull) NSString *codecDefinition;

    Swift

    var codecDefinition: String { get }

  • Returns Codec Payload Number

    Declaration

    Objective-C

    @property (nonatomic, readonly, nonnull) NSString *payloadNumber;

    Swift

    var payloadNumber: String { get }

  • Returns the Custom Codec Properties

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) NSDictionary<NSString *, NSString *> *customProperties;

    Swift

    var customProperties: [String : String]? { get }