CallOptions
@available(iOS 12.0, *)
@objc(BDKCallOptions)
public class CallOptions : NSObject
A value object representing the options used when creating a call.
-
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.0Declaration
Swift
@objc public private(set) var recordingType: CallRecordingType { get }
-
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 }
-
The call type.
Declaration
Swift
@objc public private(set) var callType: Bandyer.CallType { get }
-
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.
-
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.
-
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.
-
A convenience initialiser creating a
CallOptions
instance setting itscallType
to the value provided as argument. TherecordingType
value will be set toCallRecordingType.none
. ThemaximumDuration
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 thecallType
provided as argument and therecordingType
andmaximumDuration
properties set to default values. -
A convenience initialiser creating a
CallOptions
instance setting thecallType
and therecordingType
properties to the values provided as arguments. ThemaximumDuration
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 thecallType
andrecordingType
properties set to the values provided as arguments. ThemaximumDuration
property will be set to the default value (0). -
A convenience initialiser creating a
CallOptions
instance setting thecallType
and themaximumDuration
properties to the values provided as arguments. TherecordingType
value will be set toCallRecordingType.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 thecallType
andmaximumDuration
properties set to the values provided as arguments. TherecordingType
value will be set toCallRecordingType.none
. -
The designated initialiser creating a
CallOptions
instance setting itscallType
,recordingType
andmaximumDuration
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 thecallType
,recordingType
andmaximumDuration
properties set to the values provided as arguments.
-
Creates a
CallOptions
instance setting thecallType
to the value provided as argument. TherecordingType
value will be set toCallRecordingType.none
. ThemaximumDuration
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 thecallType
provided as argument and therecordingType
andmaximumDuration
properties set to default values. -
Creates a
CallOptions
instance setting thecallType
and therecordingType
properties to the values provided as arguments. ThemaximumDuration
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 thecallType
andrecordingType
properties set to the values provided as arguments. ThemaximumDuration
property will be set to the default value (0). -
Creates a
CallOptions
instance setting thecallType
and themaximumDuration
properties to the values provided as arguments. TherecordingType
value will be set toCallRecordingType.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 thecallType
andmaximumDuration
properties set to the values provided as arguments. TherecordingType
value will be set toCallRecordingType.none
. -
Creates a
CallOptions
instance setting itscallType
,recordingType
andmaximumDuration
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 thecallType
,recordingType
andmaximumDuration
properties set to the values provided as arguments.