PayloadType

public class PayloadType : LinphoneObject

Object representing an RTP payload type.

  • Undocumented

    Declaration

    Swift

    public static func getSwiftObject(cObject: OpaquePointer) -> PayloadType
  • Undocumented

    Declaration

    Swift

    public var getCobject: OpaquePointer? { get }
  • Get the number of channels.

    Declaration

    Swift

    public var channels: Int { get }

    Return Value

    The number of channels.

  • Get the clock rate of a payload type.

    Declaration

    Swift

    public var clockRate: Int { get }

    Return Value

    The clock rate in Hz.

  • Return a string describing a payload type. The format of the string is //.

    Declaration

    Swift

    public var description: String { get }

    Return Value

    The description of the payload type. Must be release after use.

  • Get a description of the encoder used to provide a payload type.

    Declaration

    Swift

    public var encoderDescription: String { get }

    Return Value

    The description of the encoder. Can be nil if the payload type is not supported by Mediastreamer2.

  • Check whether the payload is usable according the bandwidth targets set in the core.

    Declaration

    Swift

    public var isUsable: Bool { get }

    Return Value

    true if the payload type is usable.

  • Tells whether the specified payload type represents a variable bitrate codec.

    Declaration

    Swift

    public var isVbr: Bool { get }

    Return Value

    true if the payload type represents a VBR codec, false instead.

  • Get the mime type.

    Declaration

    Swift

    public var mimeType: String { get }

    Return Value

    The mime type.

  • Get the normal bitrate in bits/s.

    Declaration

    Swift

    public var normalBitrate: Int { get set }

    Return Value

    The normal bitrate in bits/s or -1 if an error has occured.

  • Returns the payload type number assigned for this codec.

    Declaration

    Swift

    public var number: Int { get set }

    Return Value

    The number of the payload type.

  • Get the format parameters for incoming streams.

    Declaration

    Swift

    public var recvFmtp: String { get set }

    Return Value

    The format parameters as string.

  • Get the format parameters for outgoing streams.

    Declaration

    Swift

    public var sendFmtp: String { get set }

    Return Value

    The format parameters as string.

  • Get the type of a payload type.

    Declaration

    Swift

    public var type: Int { get }

    Return Value

    The type of the payload e.g. PAYLOAD_AUDIO_CONTINUOUS or PAYLOAD_VIDEO.

  • Instantiates a new payload type with values from source.

    Declaration

    Swift

    public func clone() -> PayloadType?

    Return Value

    The newly created PayloadType object.

  • Enable/disable a payload type.

    Declaration

    Swift

    public func enable(enabled: Bool) -> Int

    Parameters

    enabled

    Set true for enabling and false for disabling.

    Return Value

    0 for success, -1 for failure.

  • Check whether a palyoad type is enabled.

    Declaration

    Swift

    public func enabled() -> Bool

    Return Value

    true if enabled, false if disabled.