BCXCallOptions

Objective-C

@interface BCXCallOptions : NSObject <NSCopying>

Swift

class BCXCallOptions : NSObject, NSCopying

A value object representing the options used when creating a call.

This is a value object so instances can be checked for equality.

Properties


                    
                    
                    recording

A flag indicating whether recording is enabled or not

Declaration

Objective-C

@property (nonatomic, copy, readonly, nullable) NSNumber *recording;

Swift

@NSCopying var recording: NSNumber? { get }

duration
The maximum duration in seconds for the call, if nil the call will end when all participants leave
Declaration
Objective-C

@property (nonatomic, copy, readonly, nullable) NSNumber *duration;
Swift

@NSCopying var duration: NSNumber? { get }

Call type


                    
                    
                    callType

The call type.

Declaration

Objective-C

@property (nonatomic, readonly) BCXCallType callType;

Swift

var callType: BCXCallType { get }

-isAudioVideo
Returns a flag indicating whether the call type is audio / video, or not.
Declaration
Objective-C

- (BOOL)isAudioVideo;
Swift

func isAudioVideo() -> Bool
Return Value

a flag indicating whether the call type is audio / video, or not.
-isAudioUpgradable
Returns a flag indicating whether the call type is audio upgradable, or not.
Declaration
Objective-C

- (BOOL)isAudioUpgradable;
Swift

func isAudioUpgradable() -> Bool
Return Value

a flag indicating whether the call type is audio upgradable, or not.
-isAudioOnly
Returns a flag indicating whether the call type is audio only, or not.
Declaration
Objective-C

- (BOOL)isAudioOnly;
Swift

func isAudioOnly() -> Bool
Return Value

a flag indicating whether the call type is audio only, or not.

Copy


                    
                    
                    -optionsWithRecording:

Creates a new call options instance copying the receiver and updating its recording flag with the value provided as argument.

Declaration

Objective-C

- (nonnull BCXCallOptions *)optionsWithRecording:(BOOL)recording;

Swift

func withRecording(_ recording: Bool) -> BCXCallOptions

Parameters


                                recording

A flag indicating whether recording should be enabled or not.

Return Value

a copy of the receiver with recording flag set to the argument provided.


                    
                    
                    -optionsWithDuration:

Creates a new call options instance copying the receiver and updating its duration value with the value provided as argument.

Declaration

Objective-C

- (nonnull BCXCallOptions *)optionsWithDuration:(NSUInteger)duration;

Swift

func withDuration(_ duration: UInt) -> BCXCallOptions

Parameters


                                duration

The duration of the call.

Return Value

a copy of the receiver with the duration value set to the argument provided.


                    
                    
                    -optionsWithCallType:

Creates a new call options instance copying the receiver and updating its call type value with the value provided as argument.

Declaration

Objective-C

- (nonnull BCXCallOptions *)optionsWithCallType:(BCXCallType)callType;

Swift

func withCallType(_ callType: BCXCallType) -> BCXCallOptions

Parameters


                                callType

The call type.

Return Value

a copy of the receiver with the call type value set to the argument provided.

Initialization


                    
                    
                    +optionsWithRecording:

Creates an option instance setting the recording option, and the call type to BCXCallTypeAudioVideo.

Declaration

Objective-C

+ (nonnull instancetype)optionsWithRecording:(BOOL)recording;

Swift

convenience init(recording: Bool)

Parameters


                                recording

A flag indicating whether the call should be recorded or not.

Return Value

An option instance with the recording flag set to the value provided, and call type set to BCXCallTypeAudioVideo.


                    
                    
                    +optionsWithDuration:

Creates an option instance setting the maximum duration for a call in seconds, and the call type to BCXCallTypeAudioVideo.

Declaration

Objective-C

+ (nonnull instancetype)optionsWithDuration:(NSUInteger)duration;

Swift

convenience init(duration: UInt)

Parameters


                                duration

The maximum duration in seconds for the call.

Return Value

An option instance with maximum duration for the call set, and call type set to BCXCallTypeAudioVideo.


                    
                    
                    +optionsWithCallType:

Creates an option instance setting the call type to the value provided as argument.

Declaration

Objective-C

+ (nonnull instancetype)optionsWithCallType:(BCXCallType)callType;

Swift

convenience init(callType: BCXCallType)

Parameters


                                callType

The call type.

Return Value

An option instance with call type set to value provided as argument.


                    
                    
                    +optionsWithRecording:duration:

Creates an option instance specifying whether call recording should be enabled or not, the maximum duration for the call in seconds, and the call type to BCXCallTypeAudioVideo.

Declaration

Objective-C

+ (nonnull instancetype)optionsWithRecording:(BOOL)recording
                                    duration:(NSUInteger)duration;

Swift

convenience init(recording: Bool, duration: UInt)

Parameters

`recording`	A flag indicating whether the call should be recorded or not.
`duration`	The maximum duration in seconds for the call.

Return Value

An option instance with the recording flag set and with maximum duration for the call set, and call type set to BCXCallTypeAudioVideo.


                    
                    
                    +optionsWithRecording:duration:callType:

Creates an option instance specifying whether call recording should be enabled or not, the maximum duration for the call in seconds, and the call type.

Declaration

Objective-C

+ (nonnull instancetype)optionsWithRecording:(BOOL)recording
                                    duration:(NSUInteger)duration
                                    callType:(BCXCallType)callType;

Swift

convenience init(recording: Bool, duration: UInt, callType: BCXCallType)

Parameters

`recording`	A flag indicating whether the call should be recorded or not.
`duration`	The maximum duration in seconds for the call.
`callType`	The call type.

Return Value

An option instance with the recording flag set, with maximum duration for the call set, and call type set to the values provided.


                    
                    
                    +optionsFromOptions:withRecording:

Creates a copy of the options provided as argument, using the recording flag provided as second argument.

Declaration

Objective-C

+ (nonnull instancetype)optionsFromOptions:(nonnull BCXCallOptions *)options
                             withRecording:(BOOL)recording;

Swift

convenience init(from options: BCXCallOptions, withRecording recording: Bool)

Parameters

`options`	The options to copy.
`recording`	A flag indicating whether the call should be recorded or not.

Return Value

A copy of the options provided, using the recording flag provided as argument.


                    
                    
                    +optionsFromOptions:withDuration:

Creates a copy of the options provided as argument, using the duration provided as second argument.

Declaration

Objective-C

+ (nonnull instancetype)optionsFromOptions:(nonnull BCXCallOptions *)options
                              withDuration:(NSUInteger)duration;

Swift

convenience init(from options: BCXCallOptions, withDuration duration: UInt)

Parameters

`options`	The options to copy.
`duration`	The maximum duration in seconds for the call.

Return Value

A copy of the options provided, using the duration provided as argument.


                    
                    
                    +optionsFromOptions:withCallType:

Creates a copy of the options provided as argument, using the call type provided as second argument.

Declaration

Objective-C

+ (nonnull instancetype)optionsFromOptions:(nonnull BCXCallOptions *)options
                              withCallType:(BCXCallType)callType;

Swift

convenience init(from options: BCXCallOptions, with callType: BCXCallType)

Parameters

`options`	The options to copy.
`callType`	The call type.

Return Value

A copy of the options provided, using the call type flag provided as argument.