com.bistri.api

Class Conference

java.lang.Object

com.bistri.api.Conference

public class Conference
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Conference.AudioCodec Audio codec available
static class	Conference.AudioOption Audio options
static class	Conference.ErrorEvent
static class	Conference.GeneralOption General options
static interface	Conference.Listener Conference event listener
static interface	Conference.Member Room member.
static class	Conference.Presence User presence
static class	Conference.RoomEvent Room event
static class	Conference.Status Connection status
static class	Conference.VideoOption Video options

Field Summary

Fields

Modifier and Type	Field and Description
static int	CALL_ERROR
static int	CONF_EVENT
static int	CONNECTION_EVENT
static int	ROOM_MEMBERS
static int	TYPE_AUDIO
static int	TYPE_VIDEO

Method Summary

Modifier and Type	Method and Description
void	__updateLocalOrientation()
void	addListener(Conference.Listener listener) Add a bistri conference listener.
void	connect() Connect to bistri conference service.
void	disconnect() Disconnect.
Conference.AudioCodec	getAudioOption_AudioCodec(Conference.AudioOption option) Get audio option has AudioCodec enum.
int	getAudioOption_int(Conference.AudioOption option) Get audio option has integer.
String	getAudioOption_string(Conference.AudioOption option) Get audio option has String.
int	getCameraId() Get the current camera index.
ArrayList<android.hardware.Camera.CameraInfo>	getCameraInfos() Get information about available cameras.
int	getCameraNb() Get the number of available camera.
android.content.Context	getContext() Return the application context that has been set with getInstance.
String	getGeneralOption_String(Conference.GeneralOption option) Get general option has String.
static Conference	getInstance() Get the current instance of bistri conference object.
static Conference	getInstance(android.content.Context context) Get the instance of bistri conference object.
android.view.SurfaceView	getLocalRender()
PeerStream	getLocalStream() Return the local peer stream.
void	getMembers(String roomName) Get members of a room.
String[]	getPeerStream_Ids() Return an identifiers array of peers currently in the room.
PeerStream	getPeerStream(String peerId) Return a peer stream from peer ID.
PeerStream	GetPeerStream(String peerId) Deprecated. Will be removed in version 1.1.0
void	getPresence(String remoteUserId) Get presence of a remote peer.
String	getRoomName() Return the current room name.
Conference.Status	getState() Deprecated. Will be removed in version 1.1.0
Conference.Status	getStatus() Get the connection status.
String	getUserId() Get your own user identifier.
int	getVideoOption_int(Conference.VideoOption option) Get video option has int.
String	getVideoOption_string(Conference.VideoOption option) Get video option has String.
boolean	hasAudioOption(Conference.AudioOption option) Check if an audio option has been set.
boolean	hasGeneralOption(Conference.GeneralOption option) Check if a general option has been set.
boolean	hasVideoOption(Conference.VideoOption option) Check if a video option has been set.
boolean	isInRoom() Deprecated. Will be removed in version 1.1.0
void	join(String roomName) Join a room.
void	join(String roomName, int roomMaxCapacity) Join a room without user name.
void	leave() Deprecated. Will be removed in version 1.1.0
void	leave(String room) Leave the current room.
void	mute(String peer_id, int type, boolean mute) Deprecated. Will be removed in version 1.1.0
void	mute(String room, String peer_id, int type, boolean mute) Mute/Unmute an audio or video stream.
void	openDataChannel(String peerId, String label, String roomName) open data stream
void	removeListener(Conference.Listener listener) Remove a bistri conference listener.
void	setAudioOption(Conference.AudioOption option, Conference.AudioCodec value) Set audio options.
void	setAudioOption(Conference.AudioOption option, int value) Set audio options.
void	setCameraId(int id) Check if a room is joined
void	setGeneralOption(Conference.GeneralOption option, String value) Set a general option.
boolean	setInfo(String appId, String appKey) Set credential information.
boolean	setInfo(String appId, String appKey, String userName) Set credential information.
boolean	setInfo(String appId, String appKey, String userName, String userId) Set credential information.
void	setLoudspeaker(boolean enable) Enable/disable loud speaker.
void	setPresence(Conference.Presence presence) Set your own presence.
void	setVideoOption(Conference.VideoOption option, int value) Set video options.
void	setView(String room, String peer_id, android.view.SurfaceView view) Set video render view.
void	setView(String peer_id, android.view.SurfaceView view) Deprecated. Will be removed in version 1.1.0

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CONNECTION_EVENT

public static final int CONNECTION_EVENT

See Also:

Constant Field Values

CALL_ERROR

public static final int CALL_ERROR

See Also:

Constant Field Values

CONF_EVENT

public static final int CONF_EVENT

See Also:

Constant Field Values

ROOM_MEMBERS

public static final int ROOM_MEMBERS

See Also:

Constant Field Values

TYPE_AUDIO

public static final int TYPE_AUDIO

See Also:

Constant Field Values

TYPE_VIDEO

public static final int TYPE_VIDEO

See Also:

Constant Field Values

Method Detail

getLocalRender

public android.view.SurfaceView getLocalRender()

__updateLocalOrientation

public void __updateLocalOrientation()

getCameraNb

public int getCameraNb()

Get the number of available camera.

 
     // Usage
     int nbCamera = bistriConference.getCameraNb();
 
 

Returns:

camera number.

getCameraInfos

public ArrayList<android.hardware.Camera.CameraInfo> getCameraInfos()

Get information about available cameras.

 
     // Usage
     ArrayList<CameraInfo> cameraInfoList = bistriConference.getCameraInfos();
 
 

Returns:

an ArrayList of CameraInfo.

getInstance

public static Conference getInstance(android.content.Context context)

Get the instance of bistri conference object. If no previous instance already exists, a new one will be created.

 
     // Usage
     Conference bistriConference = Conference.getInstance( getApplicationContext() );
 
 

Parameters:

context - (android.content.Context) Application context.

Returns:

Conference object.

getInstance

public static Conference getInstance()

Get the current instance of bistri conference object.

Returns:

Conference object or null if no previous instance already exists.

setInfo

public boolean setInfo(String appId,
                       String appKey)

Set credential information. WARNING: Your application package name is automaticaly used as "referrer". So, to be able to use this android API, don't forget to add your package name into referrer

 
     // Usage
     bistriConference.setInfo( "36846eab", "4c304359baa6d0bd1f9106aaeb215f22" );
 
 

Parameters:

appId - (String) Your application Identifier

appKey - (String) Your application Key

Returns:

True if appId and appKey seem valid.

setInfo

public boolean setInfo(String appId,
                       String appKey,
                       String userName)

Set credential information. WARNING: Your application package name is automaticaly used as "referrer". So, to be able to use this android API, don't forget to add your package name into referrer

 
     // Usage
     bistriConference.setInfo( "36846eab", "4c304359baa6d0bd1f9106aaeb215f22", userName );
 
 

Parameters:

appId - (String) Your application Identifier

appKey - (String) Your application Key

userName - (String) User name

Returns:

True if appId and appKey seem valid.

setInfo

public boolean setInfo(String appId,
                       String appKey,
                       String userName,
                       String userId)

Set credential information. WARNING: Your application package name is automaticaly used as "referrer". So, to be able to use this android API, don't forget to add your package name into referrer

 
     // Usage
     bistriConference.setInfo( "36846eab", "4c304359baa6d0bd1f9106aaeb215f22", userName );
 
 

Parameters:

appId - (String) Your application Identifier

appKey - (String) Your application Key

userName - (String) User name

userId - (String) User identifier

Returns:

True if appId and appKey seem valid.

addListener

public void addListener(Conference.Listener listener)

Add a bistri conference listener.

 
     // Usage
     bistriConference.addListener( myListener );
 
 

Parameters:

listener - (bistri.conference.Listener)

removeListener

public void removeListener(Conference.Listener listener)

Remove a bistri conference listener.

 
     // Usage
     bistriConference.removeListener( myListener );
 
 

Parameters:

listener - (bistri.conference.Listener)

connect

public void connect()

Connect to bistri conference service.

 
     // Usage
     bistriConference.connect();
 
 

disconnect

public void disconnect()

Disconnect.

 
     // Usage
     bistriConference.disconnect();
 
 

getStatus

public Conference.Status getStatus()

Get the connection status.

 
     // Usage
     bistriConference.getStatus();
 
 

Returns:

Status.

getState

public Conference.Status getState()

Deprecated. Will be removed in version 1.1.0

Returns:

Status.

See Also:

getStatus()

join

public void join(String roomName)

Join a room.

 
     // Usage
     bistriConference.join( "MyRoomName" );
 
 

Parameters:

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

openDataChannel

public void openDataChannel(String peerId,
                            String label,
                            String roomName)

open data stream

 
     // Usage
     bistriConference.openDataStream( peerId, "MyDataChannel", "MyCallingRoom" );
 
 

Parameters:

peerId - (String) peer identifier.

label - (String) data stream label.

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

join

public void join(String roomName,
                 int roomMaxCapacity)

Join a room without user name.

 
     // Usage
     bistriConference.join( "MyRoomName", 4 );
 
 

Parameters:

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

roomMaxCapacity - The room maximum number of participants in a room by using the roomMaxCapacity parameter. Only the first person joining the room can set the limitation. By default the maximum number of participants is limited to 256

leave

public void leave()

Deprecated. Will be removed in version 1.1.0

Leave the current room.

 
     // Usage
     bistriConference.leave();
 
 

leave

public void leave(String room)

Leave the current room.

 
     // Usage
     bistriConference.leave();
 
 

Parameters:

room - (String) room name

isInRoom

public boolean isInRoom()

Deprecated. Will be removed in version 1.1.0

Check if a room is joined

 
     // Usage
     if ( bistriConference.isInRoom() == true ) { ... }
 
 

Returns:

True if a room is joined, false otherwise.

setCameraId

public void setCameraId(int id)

Check if a room is joined

 
     // Usage
     bistriConference.setCameraId( facingBackCameraIndex );
 
 

Parameters:

id - (int) camera identifier. Also the camera index of getCameraInfos().

getCameraId

public int 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.

 
     // Usage
     int index = bistriConference.getCameraId();
 
 

Returns:

current camera index.

getRoomName

public String getRoomName()

Return the current room name.

 
     // Usage
     String roomName = bistriConference.getRoomName();
 
 

Returns:

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

setView

public void setView(String peer_id,
                    android.view.SurfaceView view)

Deprecated. Will be removed in version 1.1.0

Set video render view.

 
     // Usage
     String roomName = bistriConference.setView(peer_id, view);
 
 

Parameters:

peer_id - (String) peer identifier

view - (SurfaceView) SurfaceView where video is rendered

setView

public void setView(String room,
                    String peer_id,
                    android.view.SurfaceView view)

Set video render view.

 
     // Usage
     String roomName = bistriConference.setView(peer_id, view);
 
 

Parameters:

room - (String) room name

peer_id - (String) peer identifier

view - (SurfaceView) SurfaceView where video is rendered

mute

public void mute(String peer_id,
                 int type,
                 boolean mute)

Deprecated. Will be removed in version 1.1.0

Mute/Unmute an audio or video stream.

 
     // Usage
     bistriConference.mute( "local", Conference.TYPE_AUDIO, true );
 
 

Parameters:

peer_id - (String) peer identifier

type - (int) type of stream:Conference.TYPE_AUDIO or Conference.TYPE_VIDEO.

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

mute

public void mute(String room,
                 String peer_id,
                 int type,
                 boolean mute)

Mute/Unmute an audio or video stream.

 
     // Usage
     bistriConference.mute( "local", Conference.TYPE_AUDIO, true );
 
 

Parameters:

room - (String) room name

peer_id - (String) peer identifier

type - (int) type of stream:Conference.TYPE_AUDIO or Conference.TYPE_VIDEO.

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

getContext

public android.content.Context getContext()

Return the application context that has been set with getInstance.

 
     // Usage
     Context ctx = bistriConference.getContext();
 
 

Returns:

android.content.Context.

getLocalStream

public PeerStream getLocalStream()

Return the local peer stream.

 
     // Usage
     PeerStream localPeer = bistriConference.getLocalStream();
 
 

Returns:

PeerStream.

getPeerStream

public PeerStream getPeerStream(String peerId)

Return a peer stream from peer ID.

 
     // Usage
     PeerStream peer = bistriConference.getPeerStream( remotePeerId );
 
 

Parameters:

peerId - (String) peer identifier

Returns:

PeerStream.

GetPeerStream

public PeerStream GetPeerStream(String peerId)

Deprecated. Will be removed in version 1.1.0

Parameters:

peerId - (String) peer identifier

Returns:

PeerStream.

See Also:

getPeerStream( String peerId )

getPeerStream_Ids

public String[] getPeerStream_Ids()

Return an identifiers array of peers currently in the room.

 
     // Usage
     Context ctx = bistriConference.getPeerStream_Ids();
 
 

Returns:

String[].

setGeneralOption

public void setGeneralOption(Conference.GeneralOption option,
                             String value)

Set a general option.

 
     // Usage
     bistriConference.setGeneralOption( GeneralOption.GL_RENDERER, CustomGLRenderer.class.getName() );
 
 

Parameters:

option - (Conference.GeneralOption)

value - (String) option value

hasGeneralOption

public boolean hasGeneralOption(Conference.GeneralOption option)

Check if a general option has been set.

 
     // Usage
     bistriConference.hasGeneralOption( GeneralOption.GL_RENDERER );
 
 

Parameters:

option - (Conference.GeneralOption)

Returns:

True if the given option has already been set.

getGeneralOption_String

public String getGeneralOption_String(Conference.GeneralOption option)

Get general option has String.

 
     // Usage
     bistriConference.getGeneralOption_String( GeneralOption.GL_RENDERER );
 
 

Parameters:

option - (Conference.GeneralOption)

Returns:

value has a String if possible, null otherwise.

setVideoOption

public void setVideoOption(Conference.VideoOption option,
                           int value)

Set video options.

 
     // Usage
     bistriConference.setVideoOption( VideoOption.MAX_HEIGHT, 480 );
 
 

Parameters:

option - (Conference.GeneralOption)

value - (int)

hasVideoOption

public boolean hasVideoOption(Conference.VideoOption option)

Check if a video option has been set.

 
     // Usage
     bistriConference.hasVideoOption( VideoOption.MAX_HEIGHT );
 
 

Parameters:

option - (Conference.VideoOption)

Returns:

True if the given option has already been set.

getVideoOption_int

public int getVideoOption_int(Conference.VideoOption option)

Get video option has int.

 
     // Usage
     bistriConference.getVideoOption_int( VideoOption.MAX_HEIGHT );
 
 

Parameters:

option - (Conference.VideoOption)

Returns:

value has a String if possible, null otherwise.

getVideoOption_string

public String getVideoOption_string(Conference.VideoOption option)

Get video option has String.

 
     // Usage
     bistriConference.getGeneralOption_String( VideoOption.MAX_HEIGHT );
 
 

Parameters:

option - (Conference.VideoOption)

Returns:

value has a String if possible, null otherwise.

setAudioOption

public void setAudioOption(Conference.AudioOption option,
                           Conference.AudioCodec value)

Set audio options.

 
     // Usage
     bistriConference.setAudioOption( AudioOption.PREFERRED_CODEC, AudioCodec.ISAC );
 
 

Parameters:

option - (Conference.AudioOption)

value - (Conference.AudioCodec)

setAudioOption

public void setAudioOption(Conference.AudioOption option,
                           int value)

Set audio options.

 
     // Usage
     bistriConference.setAudioOption( AudioOption.PREFERRED_CODEC_CLOCKRATE, 16000 );
 
 

Parameters:

option - (Conference.AudioOption)

value - (int)

hasAudioOption

public boolean hasAudioOption(Conference.AudioOption option)

Check if an audio option has been set.

 
     // Usage
     bistriConference.hasAudioOption( AudioOption.PREFERRED_CODEC );
 
 

Parameters:

option - (Conference.AudioOption)

Returns:

True if the given option has already been set.

getAudioOption_int

public int getAudioOption_int(Conference.AudioOption option)

Get audio option has integer.

 
     // Usage
     int clockrate = bistriConference.getAudioOption_int( AudioOption.PREFERRED_CODEC_CLOCKRATE );
 
 

Parameters:

option - (Conference.AudioOption)

Returns:

int value.

getAudioOption_AudioCodec

public Conference.AudioCodec getAudioOption_AudioCodec(Conference.AudioOption option)

Get audio option has AudioCodec enum.

 
     // Usage
     AudioCodec codec = bistriConference.getAudioOption_AudioCodec( AudioOption.PREFERRED_CODEC );
 
 

Parameters:

option - (Conference.AudioOption)

Returns:

AudioCodec value.

getAudioOption_string

public String getAudioOption_string(Conference.AudioOption option)

Get audio option has String.

 
     // Usage
     String codec_name = bistriConference.getAudioOption_string( AudioOption.PREFERRED_CODEC );
 
 

Parameters:

option - (Conference.AudioOption)

Returns:

String value.

setLoudspeaker

public void setLoudspeaker(boolean enable)

Enable/disable loud speaker.

 
     // Usage
     bistriConference.setLoudspeaker( false );
 
 

Parameters:

enable - (boolean)

getUserId

public String getUserId()

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

 
     // Usage
     String myOwnUserId = bistriConference.getUserId();
 
 

Returns:

String identifier if any, it return null otherwise.

setPresence

public void setPresence(Conference.Presence presence)

Set your own presence.

 
     // Usage
     bistriConference.setPresence( Presence.AWAY );
 
 

Parameters:

presence - (Presence)

See Also:

Conference.Presence

getPresence

public void getPresence(String remoteUserId)

Get presence of a remote peer. Presence is returned asynchronously using method "onPresence()" of Conference.Listener.

 
     // Usage
     bistriConference.getPresence( remotePeerId );
 
 

Parameters:

remoteUserId - (String) remote user identifier

See Also:

for response

getMembers

public void getMembers(String roomName)

Get members of a room.

 
     // Usage
     bistriConference.getMembers( myRoomName );
 
 

Parameters:

roomName - (String) The room name

See Also:

for response?