Inherits from NSObject
Declared in Bit6CallController.h

Overview

Bit6CallController represents a call.

Properties

answered

The incoming call was answered by using the system push notification.

@property (nonatomic, readonly) BOOL answered

Declared In

Bit6CallController.h

availableStreamsForIncomingCall

An integer bit mask that indicates the possible streams in the incoming call.

@property (nonatomic) Bit6CallStreams availableStreamsForIncomingCall

Declared In

Bit6CallController.h

callKitSupported

@property (nonatomic, readonly) BOOL callKitSupported

dataChannelState

Data channel state as a value of the Bit6CallState enumeration.

@property (nonatomic, readonly) Bit6DataChannelState dataChannelState

Declared In

Bit6CallController.h

endedCause

Cause message for the call ended, if available.

@property (nullable, nonatomic, strong, readonly) NSString *endedCause

Declared In

Bit6CallController.h

endedCauseCode

Cause code for the call ended, if available.

@property (nonatomic, readonly) FreeSWITCHHangupCause endedCauseCode

Declared In

Bit6CallController.h

error

The latest error to occur during the call.

@property (nullable, nonatomic, strong, readonly) NSError *error

Declared In

Bit6CallController.h

hasAudio

The local streams being sent include an audio track.

@property (nonatomic, readonly) BOOL hasAudio

Declared In

Bit6CallController.h

hasData

The local streams being sent include support for data transfer.

@property (nonatomic, readonly) BOOL hasData

Declared In

Bit6CallController.h

hasRemoteAudio

The remote streams being received include an audio track.

@property (nonatomic, readonly) BOOL hasRemoteAudio

Declared In

Bit6CallController.h

hasRemoteData

The remote streams being received include support for data transfer.

@property (nonatomic, readonly) BOOL hasRemoteData

Declared In

Bit6CallController.h

hasRemoteVideo

The remote streams being received include a video track.

@property (nonatomic, readonly) BOOL hasRemoteVideo

Declared In

Bit6CallController.h

hasVideo

The local streams being sent include a video track.

@property (nonatomic, readonly) BOOL hasVideo

Declared In

Bit6CallController.h

incoming

The call is an incoming call.

@property (nonatomic, readonly) BOOL incoming

Declared In

Bit6CallController.h

incomingAlert

The message shown in the incoming call system push notification.

@property (nullable, nonatomic, strong, readonly) NSString *incomingAlert

Declared In

Bit6CallController.h

incomingCallIdentifier

Unique identifier for the incoming call.

@property (nullable, nonatomic, readonly) NSString *incomingCallIdentifier

Declared In

Bit6CallController.h

incomingTransfers

List of incoming Bit6Transfer for the current call.

@property (nonatomic, readonly) NSArray<Bit6Transfer*> *incomingTransfers

Declared In

Bit6CallController.h

localStreams

An integer bit mask that indicates the local streams being sent during the call.

@property (nonatomic) Bit6CallStreams localStreams

Declared In

Bit6CallController.h

mediaMode

Indicates if the call will go P2P or if the server should process the media. P2P Can’t be used for group calls, or if offnet property is set to true.

@property (nonatomic, strong) Bit6CallMediaMode mediaMode

Declared In

Bit6CallController.h

missed

Used to know if the call ended without being answered.

@property (nonatomic, readonly) BOOL missed

Declared In

Bit6CallController.h

offnet

Indicates if the call will go within the Bit6 world (set to false) or it should be a real phone call (set to true).

@property (nonatomic) BOOL offnet

Declared In

Bit6CallController.h

other

Identity of the other side of the call.

@property (nonatomic, strong, readonly) Bit6Address *other

Declared In

Bit6CallController.h

otherDisplayName

Display name of other side of the call.

@property (nonatomic, strong) NSString *otherDisplayName

Declared In

Bit6CallController.h

outgoingTransfers

List of outgoing Bit6Transfer for the current call.

@property (nonatomic, readonly) NSArray<Bit6OutgoingTransfer*> *outgoingTransfers

Declared In

Bit6CallController.h

recording

Starts and stop recording during a call. This can only be used if call media mode is set to Bit6CallMediaModeMix.

@property (nonatomic) BOOL recording

Declared In

Bit6CallController.h

rejected

Used to know if the call didn’t connect because it was rejected.

@property (nonatomic, readonly) BOOL rejected

Declared In

Bit6CallController.h

remoteStreams

An integer bit mask that indicates the remote streams being received during the call.

@property (nonatomic) Bit6CallStreams remoteStreams

Declared In

Bit6CallController.h

seconds

The number of seconds the call has been going.

@property (nonatomic, readonly) NSUInteger seconds

Declared In

Bit6CallController.h

state

Call state as a value of the Bit6MessageStatus enumeration.

@property (nonatomic, readonly) Bit6CallState state

Discussion

For incoming calls the states go: NEW -> ACCEPTING_CALL -> WAITING_SDP -> GATHERING_CANDIDATES -> SENDING_SDP -> CONNECTING -> CONNECTED -> END
For outgoing calls the states go: NEW -> GATHERING_CANDIDATES -> SENDING_SDP -> WAITING_SDP -> CONNECTING -> CONNECTED -> END

Declared In

Bit6CallController.h

uuid

Unique identifier for the call

@property (nonatomic, strong) NSUUID *uuid

Declared In

Bit6CallController.h

Class Methods

hangupAll

Send a hangup message to all objects.

+ (void)hangupAll

Declared In

Bit6CallController.h

isBluetoothEnabled

The audio from the call is going out through a bluetooth device.

+ (BOOL)isBluetoothEnabled

Declared In

Bit6CallController.h

isLocalAudioEnabled

The audio is muted for the current call.

+ (BOOL)isLocalAudioEnabled

Declared In

Bit6CallController.h

isLocalVideoEnabled

The video is muted for the current call.

+ (BOOL)isLocalVideoEnabled

Declared In

Bit6CallController.h

isSpeakerEnabled

The audio from the call is going through the speaker.

+ (BOOL)isSpeakerEnabled

Declared In

Bit6CallController.h

localVideoSource

The current source for the video being sent.

+ (Bit6VideoSource)localVideoSource

Declared In

Bit6CallController.h

setBluetoothEnabled:

Change the audio route from the default one to the available bluetooth device, and vice versa. This will be applied to all the running callControllers.

+ (BOOL)setBluetoothEnabled:(BOOL)flag

Parameters

flag

YES to enable bluetooth.

Declared In

Bit6CallController.h

setLocalAudioEnabled:

Mute and unmute the microphone in the current call. This will be applied to all the running callControllers.

+ (void)setLocalAudioEnabled:(BOOL)flag

Parameters

flag

NO to mute the microphone.

Declared In

Bit6CallController.h

setLocalVideoEnabled:

Mute and unmute the video in the current call. This will be applied to all the running callControllers.

+ (void)setLocalVideoEnabled:(BOOL)flag

Parameters

flag

NO to mute the local video.

Declared In

Bit6CallController.h

setLocalVideoSource:

Switch between the frontal and rear camera, and other video sources if available. This will be applied to all the running callControllers.

+ (void)setLocalVideoSource:(Bit6VideoSource)source

Parameters

source

the video source to sent during the calls.

Declared In

Bit6CallController.h

setSpeakerEnabled:

Change the audio route from the default one to the speaker, and vice versa. This will be applied to all the running callControllers.

+ (BOOL)setSpeakerEnabled:(BOOL)flag

Parameters

flag

YES to enable speaker.

Declared In

Bit6CallController.h

Instance Methods

addDelegate:

Adds a delegate to be notified of changes in the call.

- (void)addDelegate:(id<Bit6CallControllerDelegate>)delegate

Parameters

delegate

object to notify of changes in the call.

Declared In

Bit6CallController.h

addTransfer:

Starts the specified Bit6OutgoingTransfer through this call. If there’s another transfer going on, this new transfer will be added to a queue.

- (void)addTransfer:(Bit6OutgoingTransfer *)transfer

Parameters

transfer

Bit6OutgoingTransfer to start.

Declared In

Bit6CallController.h

hangup

Send a hangup message to the sender.

- (void)hangup

Declared In

Bit6CallController.h

playRingtone

Play the ringtone defined in the incoming push notification payload.

- (void)playRingtone

Declared In

Bit6CallController.h

removeDelegate:

Removes a call delegate.

- (void)removeDelegate:(id<Bit6CallControllerDelegate>)delegate

Parameters

delegate

object to remove from the call delegates.

Declared In

Bit6CallController.h

start

Starts the call

- (void)start

Declared In

Bit6CallController.h

supportsCapability:

Indicates if the calls supports the specified capability.

- (BOOL)supportsCapability:(Bit6CallCapability)capability

Parameters

capability

capability to find out if the call supports.

Return Value

YES if the call supports the specified capability.

Declared In

Bit6CallController.h