Conference Class Reference

Inherits from NSObject
Declared in conference.h
conference.mm

Overview

Conference

+ presenceToString:

convert Presence to String

+ (NSString *)presenceToString:(Presence)presence

Parameters

(Presence)

presence.

Return Value

(NSString)

Discussion

convert Presence to String

Declared In

conference.h

+ presenceFromString:

convert Presence from String

+ (Presence)presenceFromString:(NSString *)presence

Parameters

(NSString)

presence.

Return Value

(Presence)

Discussion

convert Presence from String

Declared In

conference.h

+ getInstance

Get the current instance of bistri conference object.

+ (Conference *)getInstance

Return Value

Conference object or null if no previous instance already exists.

Discussion

Get the current instance of bistri conference object.

Declared In

conference.h

– setInfoWithAppID:APIKey:userName:

Set credential information. WARNING: Your application package name is automaticaly used as “referrer”.

- (BOOL)setInfoWithAppID:(NSString *)appId APIKey:(NSString *)apiKey userName:(NSString *)userName

Parameters

(NSString)

userName. User name

Return Value

True if appId and appKey seem valid.

Discussion

Set credential information. WARNING: Your application package name is automaticaly used as “referrer”.

Declared In

conference.h

– setInfoWithAppID:APIKey:userName:userId:

Set credential information. WARNING: Your application package name is automaticaly used as “referrer”.

- (BOOL)setInfoWithAppID:(NSString *)appId APIKey:(NSString *)apiKey userName:(NSString *)userName userId:(NSString *)userId

Parameters

(NSString)

userId. User identifier

Return Value

True if appId and appKey seem valid.

Discussion

Set credential information. WARNING: Your application package name is automaticaly used as “referrer”.

Declared In

conference.h

– connect

Connect to bistri conference service.

- (void)connect

Discussion

Connect to bistri conference service.

Declared In

conference.h

– disconnect

Disconnect.

- (void)disconnect

Discussion

Disconnect.

Declared In

conference.h

– getStatus

Get the connection status.

- (ConferenceConnection)getStatus

Return Value

ConferenceConnection.

Discussion

Get the connection status.

Declared In

conference.h

– join:

Join a room.

- (void)join:(NSString *)roomName

Parameters

(NSString)

roomName. The room name you want to join. It can be an existing one, or a new one. roomName can contains only a-z,A-Z,0-9,-,_

Discussion

Join a room.

Declared In

conference.h

– leave:

Leave the specified room.

- (void)leave:(NSString *)roomName

Parameters

(NSString)

roomName.

Discussion

Leave the specified room.

Declared In

conference.h

– call:inRoom:

Call the specified peerId in the specified room

- (void)call:(NSString *)peerId inRoom:(NSString *)roomName

Parameters

(NSString)

roomName. The room where the call take place. Room name can contains only a-z,A-Z,0-9,-,_

Discussion

Call the specified peerId in the specified room

Declared In

conference.h

– openDataChannel:withLabel:inRoom:

Open a DataChannel with the current peer in the specified room.

- (void)openDataChannel:(NSString *)peerId withLabel:(NSString *)label inRoom:(NSString *)roomName

Parameters

(NSString)

roomName. The room where the call take place. Room name can contains only a-z,A-Z,0-9,-,_

Discussion

Open a DataChannel with the current peer in the specified room.

Declared In

conference.h

– setLoudspeaker:

Enable/disable loud speaker.

- (void)setLoudspeaker:(bool)enable

Parameters

(bool)

enable.

Discussion

Enable/disable loud speaker.

Declared In

conference.h

– getRoomName

Return the current room name.

- (NSString *)getRoomName

Return Value

the current room name. If no room is joined, null is returned.

Discussion

Return the current room name.

Declared In

conference.h

– mute:room:peerId:type:

Mute/Unmute an audio or video stream.

- (void)mute:(bool)mute room:(NSString *)room peerId:(NSString *)peerId type:(MediaType)type

Parameters

(MediaType)

type the media (AUDIO/VIDEO).
(bool)

mute. True will mute selected stream, false will unmute it.
(NSString)

peerId. Peer identifier.

Discussion

Mute/Unmute an audio or video stream.

Declared In

conference.h

– getLocalStream

Return the local peer stream.

- (PeerStream *)getLocalStream

Return Value

PeerStream.

Discussion

Return the local peer stream.

Declared In

conference.h

– getPeerStream:

Return a peer stream from peer ID.

- (PeerStream *)getPeerStream:(NSString *)peerId

Parameters

(NSString)

peerId. Peer identifier.

Return Value

PeerStream.

Discussion

Return a peer stream from peer ID.

Declared In

conference.h

– getPeerStreamIds

Return an identifiers array of peers currently in the room.

- (NSArray *)getPeerStreamIds

Return Value

NSArray;

Discussion

Return an identifiers array of peers currently in the room.

Declared In

conference.h

– removePeerStream:

Remove peer stream

- (void)removePeerStream:(NSString *)peerId

Parameters

(NSString)

peerId. Peer identifier.

Discussion

Remove peer stream

Declared In

conference.h

– getCameraNb

Get the number of available camera.

- (int)getCameraNb

Return Value

camera number.

Discussion

Get the number of available camera.

Declared In

conference.h

– getCameraInfos

Get information about available cameras.

- (NSArray *)getCameraInfos

Return Value

an ArrayList of CameraInfo.

Discussion

Get information about available cameras.

Declared In

conference.h

– setCameraId:

Set Camera Id

- (void)setCameraId:(int)id

Parameters

(int)

id. Camera identifier. Also the camera index of getCameraInfos().

Discussion

Set Camera Id

Declared In

conference.h

– getCameraId

Get the current camera index. Can return -1 if setCameraId has never been called; -1 means library will choose the first front-facing camera available.

- (int)getCameraId

Return Value

current camera index.

Discussion

Get the current camera index. Can return -1 if setCameraId has never been called; -1 means library will choose the first front-facing camera available.

Declared In

conference.h

– setGeneralOption:withValue:

Set general options.

- (void)setGeneralOption:(ConferenceGeneralOption)option withValue:(bool)value

Parameters

(ConferenceGeneralOption)

option.
(bool)

value.

Discussion

Set general options.

Declared In

conference.h

– hasGeneralOption:

Check if a general option has been set.

- (bool)hasGeneralOption:(ConferenceGeneralOption)option

Parameters

(ConferenceGeneralOption)

option.

Return Value

True if the given option has already been set.

Discussion

Check if a general option has been set.

Declared In

conference.h

– getGeneralOptionAsString:

Get general option has String.

- (NSString *)getGeneralOptionAsString:(ConferenceGeneralOption)option

Parameters

(ConferenceGeneralOption)

option.

Return Value

value has a String if possible, null otherwise.

Discussion

Get general option has String.

Declared In

conference.h

– setVideoOption:withCodecValue:

Set video options.

- (void)setVideoOption:(ConferenceVideoOption)option withCodecValue:(ConferenceVideoCodec)value

Parameters

(ConferenceVideoOption)

option.
(ConferenceVideoCodec)

value.

Discussion

Set video options.

Declared In

conference.h

– getVideoOptionAsVideoCodec:

Get video option has ConferenceVideoCodec enum.

- (ConferenceVideoCodec)getVideoOptionAsVideoCodec:(ConferenceVideoOption)option

Parameters

(ConferenceVideoOption)

option.

Return Value

ConferenceVideoCodec value.

Discussion

Get video option has ConferenceVideoCodec enum.

Declared In

conference.h

– setVideoOption:withIntgValue:

Set video options.

- (void)setVideoOption:(ConferenceVideoOption)option withIntgValue:(int)value

Parameters

(ConferenceVideoOption)

option
(int)

value

Discussion

Set video options.

Declared In

conference.h

– hasVideoOption:

Check if a video option has been set.

- (bool)hasVideoOption:(ConferenceVideoOption)option

Parameters

(ConferenceVideoOption)

option.

Return Value

True if the given option has already been set.

Discussion

Check if a video option has been set.

Declared In

conference.h

– getVideoOptionAsInteger:

Get video option has int.

- (int)getVideoOptionAsInteger:(ConferenceVideoOption)option

Parameters

(ConferenceVideoOption)

option.

Return Value

value if possible, null otherwise.

Discussion

Get video option has int.

Declared In

conference.h

– getVideoOptionAsString:

Get video option has String.

- (NSString *)getVideoOptionAsString:(ConferenceVideoOption)option

Parameters

(ConferenceVideoOption)

option.

Return Value

value has a String if possible, null otherwise.

Discussion

Get video option has String.

Declared In

conference.h

– setAudioOption:withCodecValue:

Set audio options.

- (void)setAudioOption:(ConferenceAudioOption)option withCodecValue:(ConferenceAudioCodec)value

Parameters

(ConferenceAudioCodec)

value.
(ConferenceAudioOption)

option.

Discussion

Set audio options.

Declared In

conference.h

– setAudioOption:withIntValue:

Set audio options.

- (void)setAudioOption:(ConferenceAudioOption)option withIntValue:(int)value

Parameters

(int)

value.
(ConferenceAudioOption)

option.

Discussion

Set audio options.

Declared In

conference.h

– hasAudioOption:

Check if an audio option has been set.

- (bool)hasAudioOption:(ConferenceAudioOption)option

Parameters

(ConferenceAudioOption)

option.

Return Value

True if the given option has already been set.

Discussion

Check if an audio option has been set.

Declared In

conference.h

– getAudioOptionAsAudioCodec:

Get audio option has ConferenceAudioCodec enum.

- (ConferenceAudioCodec)getAudioOptionAsAudioCodec:(ConferenceAudioOption)option

Parameters

(ConferenceAudioOption)

option.

Return Value

ConferenceAudioCodec value.

Discussion

Get audio option has ConferenceAudioCodec enum.

Declared In

conference.h

– getAudioOptionAsInt:

Get audio option has integer.

- (int)getAudioOptionAsInt:(ConferenceAudioOption)option

Parameters

(ConferenceAudioOption)

option.

Return Value

int value.

Discussion

Get audio option has integer.

Declared In

conference.h

– getAudioOptionAsString:

Get audio option has String.

- (NSString *)getAudioOptionAsString:(ConferenceAudioOption)option

Parameters

(ConferenceAudioOption)

option.

Return Value

String value.

Discussion

Get audio option has String.

Declared In

conference.h

– getUserId

Get your own user identifier. This identifier is set by the conference server after been connected.

- (NSString *)getUserId

Return Value

String identifier if any, it return null otherwise.

Discussion

Get your own user identifier. This identifier is set by the conference server after been connected.

Declared In

conference.h

– setPresence:

Set your own presence.

- (void)setPresence:(Presence)presence

Parameters

(Presence)

presence.

Discussion

Set your own presence.

Declared In

conference.h

– getPresence:

Get presence of a remote peer.

- (void)getPresence:(NSString *)peerId

Parameters

(NSString)

peerId remote user identifier

Discussion

Get presence of a remote peer.

Declared In

conference.h

– getMembers:

Get members of a room.

- (void)getMembers:(NSString *)roomName

Parameters

(NSString)

roomName. The room name

Discussion

Get members of a room.

Declared In

conference.h

– applicationIsActive

Informs api that application is active.

- (void)applicationIsActive

Discussion

Informs api that application is active.

Declared In

conference.h

– applicationInBackground

Informs api that application enter in background.

- (void)applicationInBackground

Discussion

Informs api that application enter in background.

Declared In

conference.h