CallOptions Class Reference

Properties

recordingType
A value indicating whether the call can be recorded or not.

When the value of this property is CallRecordingType.none the call won’t be recorded.

Since
3.0.0
Declaration
Swift

@objc public private(set) var recordingType: CallRecordingType { get }
maximumDuration
The maximum duration in seconds for the call. If the value is zero the call will last until all participants have left.
Declaration
Swift

@objc public private(set) var maximumDuration: UInt { get }

Call type


                    
                    
                    callType

The call type.

Declaration

Swift

@objc
public private(set) var callType: Bandyer.CallType { get }

isAudioVideo()
Returns a flag indicating whether the call type is audio / video, or not.
Declaration
Swift

@objc public 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
Swift

@objc public 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
Swift

@objc public func isAudioOnly() -> Bool
Return Value

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

Initialization


                    
                    
                    init(callType:)

A convenience initialiser creating a CallOptions instance setting its callType to the value provided as argument. The recordingType value will be set to CallRecordingType.none. The maximumDuration value will be set to zero (call will last until all participants have left the call).

Declaration

Swift

@objc(initWithCallType:)
public convenience init(callType: Bandyer.CallType)

Parameters


                                callType

The callType of the call.

Return Value

A CallOptions instance with the callType provided as argument and the recordingType and maximumDuration properties set to default values.


                    
                    
                    init(callType:recordingType:)

A convenience initialiser creating a CallOptions instance setting the callType and the recordingType properties to the values provided as arguments. The maximumDuration value will be set to zero (the call will last until all participants have left the call).

Since

3.0.0

Declaration

Swift

@objc(initWithCallType:recordingType:)
public convenience init(callType: Bandyer.CallType, recordingType: CallRecordingType)

Parameters

`callType`	The `callType` of the call.
`recordingType`	The `recordingType` for the call.

Return Value

A CallOptions instance with the callType and recordingType properties set to the values provided as arguments. The maximumDuration property will be set to the default value (0).


                    
                    
                    init(callType:duration:)

A convenience initialiser creating a CallOptions instance setting the callType and the maximumDuration properties to the values provided as arguments. The recordingType value will be set to CallRecordingType.none.

Declaration

Swift

@objc(initWithCallType:duration:)
public convenience init(callType: Bandyer.CallType, duration: UInt)

Parameters

`callType`	The `callType` of the call.
`duration`	The `maximumDuration` of the call expressed in seconds. A value of zero means the call will last until all participants have left.

Return Value

A CallOptions instance with the callType and maximumDuration properties set to the values provided as arguments. The recordingType value will be set to CallRecordingType.none.


                    
                    
                    init(callType:recordingType:duration:)

The designated initialiser creating a CallOptions instance setting its callType, recordingType and maximumDuration properties to the values provided as arguments.

Since

3.0.0

Declaration

Swift

@objc(initWithCallType:recordingType:duration:)
public init(callType: Bandyer.CallType, recordingType: CallRecordingType, duration: UInt)

Parameters

`callType`	The `callType` of the call.
`recordingType`	The `recordingType` for the call.
`duration`	The `maximumDuration` of the call expressed in seconds. A value of zero means the call will last until all participants have left.

Return Value

A CallOptions instance with the callType, recordingType and maximumDuration properties set to the values provided as arguments.

Factory methods


                    
                    
                    options(with:)

Creates a CallOptions instance setting the callType to the value provided as argument. The recordingType value will be set to CallRecordingType.none. The maximumDuration value will be set to zero (call will last until all participants have left the call).

Declaration

Swift

@objc(optionsWithCallType:)
public static func options(with callType: Bandyer.CallType) -> Bandyer.CallOptions

Parameters


                                callType

The callType of the call.

Return Value

A CallOptions instance with the callType provided as argument and the recordingType and maximumDuration properties set to default values.


                    
                    
                    options(with:recordingType:)

Creates a CallOptions instance setting the callType and the recordingType properties to the values provided as arguments. The maximumDuration value will be set to zero (the call will last until all participants have left the call).

Since

3.0.0

Declaration

Swift

@objc(optionsWithCallType:recordingType:)
public static func options(with callType: Bandyer.CallType, recordingType: CallRecordingType) -> Bandyer.CallOptions

Parameters

`callType`	The `callType` of the call.
`recordingType`	The `recordingType` for the call.

Return Value

A CallOptions instance with the callType and recordingType properties set to the values provided as arguments. The maximumDuration property will be set to the default value (0).


                    
                    
                    options(with:duration:)

Creates a CallOptions instance setting the callType and the maximumDuration properties to the values provided as arguments. The recordingType value will be set to CallRecordingType.none.

Declaration

Swift

@objc(optionsWithCallType:duration:)
public static func options(with callType: Bandyer.CallType, duration: UInt) -> Bandyer.CallOptions

Parameters

`callType`	The `callType` of the call.
`duration`	The `maximumDuration` of the call expressed in seconds. A value of zero means the call will last until all participants have left.

Return Value

A CallOptions instance with the callType and maximumDuration properties set to the values provided as arguments. The recordingType value will be set to CallRecordingType.none.


                    
                    
                    options(with:recordingType:duration:)

Creates a CallOptions instance setting its callType, recordingType and maximumDuration properties to the values provided as arguments.

Since

3.0.0

Declaration

Swift

@objc(optionsWithCallType:recordingType:duration:)
public static func options(with callType: Bandyer.CallType, recordingType: CallRecordingType, duration: UInt) -> Bandyer.CallOptions

Parameters

`callType`	The `callType` of the call.
`recordingType`	The `recordingType` for the call.
`duration`	The `maximumDuration` of the call expressed in seconds. A value of zero means the call will last until all participants have left.

Return Value

A CallOptions instance with the callType, recordingType and maximumDuration properties set to the values provided as arguments.