TVOCallOptions

Objective-C

@interface TVOCallOptions : NSObject

Swift

class TVOCallOptions : NSObject

Represents options available when connecting to a Call. Normally, this class is not used directly. See TVOConnectOptions or TVOCAcceptOptions for example usage.

  • @brief The queue where the Call and associated classes will invoke delegate methods.

    @discussion All delegate methods are performed on this queue. Any TVOCall instance which is created with these options will maintain a strong reference to the queue until it is destroyed. The default value of nil indicates that the main dispatch queue will be used.

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly, nullable) dispatch_queue_t delegateQueue;

    Swift

    var delegateQueue: dispatch_queue_t? { get }

  • @brief A custom ICE configuration used to connect to a Call.

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly, nullable) TVOIceOptions *iceOptions;

    Swift

    var iceOptions: TVOIceOptions? { get }

  • @brief The collection of preferred audio codecs.

    @discussion The list specifies which audio codecs will be preferred when negotiating audio between participants. The preferences are applied in the order found in the list starting with the most preferred audio codec to the least preferred audio codec. Audio codec preferences are not guaranteed to be satisfied because not all participants are guaranteed to support all audio codecs. TVOOpusCodec is the default audio codec if no preferences are set.

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly, nonnull) NSArray<TVOAudioCodec *> *preferredAudioCodecs;

    Swift

    var preferredAudioCodecs: [TVOAudioCodec] { get }

  • @brief Enables Differentiated Services Field Code Point (DSCP) with Expedited Forwarding (EF). https://tools.ietf.org/html/draft-ietf-tsvwg-rtcweb-qos-18#section-5

    @discussion DSCP is enabled by default.

    Declaration

    Objective-C

    @property (nonatomic, readonly) BOOL enableDscp;

    Swift

    var enableDscp: Bool { get }

  • @brief Enable gathering of ICE candidates on “any address” ports. When this flag is set, ports not bound to any specific network interface will be used, in addition to normal ports bound to the enumerated interfaces. This flag may need to be set to support certain network configurations (e.g. some VPN implementations) where ports are not bound to specific interfaces. Setting this flag means that additional candidates might need to be gathered and evaluated, which could lead to slower ICE connection times for regular networks.

    Declaration

    Objective-C

    @property (nonatomic, readonly) BOOL enableIceGatheringOnAnyAddressPorts;

    Swift

    var enableIceGatheringOnAnyAddressPorts: Bool { get }

  • @brief The <TVOCallMessageDelegate> for <TVOCallMessage> related updates.

    Declaration

    Objective-C

    @property (nonatomic, weak, readonly, nullable) id<TVOCallMessageDelegate> callMessageDelegate;

    Swift

    weak var callMessageDelegate: (any TVOCallMessageDelegate)? { get }

  • @brief The <TVOAudioOptions> that can be applied to underlying media streams or audio processing.

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly, nullable) TVOAudioOptions *audioOptions;

    Swift

    var audioOptions: TVOAudioOptions? { get }

  • Unavailable

    Use the TVOConnectOptions or TVOAcceptOptions initializer instead.

    @brief Developers shouldn’t initialize this class directly.

    @discussion Use the TVOConnectOptions or TVOAcceptOptions builder method instead.

    Declaration

    Objective-C

    - (null_unspecified instancetype)init;

CallKit

  • @brief The CallKit identifier for the Call. You must set this property if you are using CallKit to manage the Call.

    @discussion This property allows you to provide your CallKit UUID as part of TVOConnectOptions or TVOAcceptOptions. This is offered as a convenience if you wish to useTVOCallfor CallKit book keeping. The UUID set here will be reflected on any TVOCall` instance created with these options.

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly, nullable) NSUUID *uuid;

    Swift

    var uuid: UUID? { get }