MeetingSDK

open class MeetingSDK

The MeetingSDK class is the entry point to the Visionable Android SDK. It is a singleton that provides static access to all methods. It must be initialized through initializeSDK method and released using destroySDK to ensure all resources allocated will be released.

Types

ConnectionStatus

enum ConnectionStatus

DebugLevel

enum DebugLevel

NetworkQuality

enum NetworkQuality

TYPE

enum TYPE

Functions

audioSetTraceLevel

open fun audioSetTraceLevel(level: MeetingSDK.DebugLevel)

audioSetTraceLevelSets the trace debug level for audio library

audioTraceOutputHistory

open fun audioTraceOutputHistory(filename: String)

Write audio log messages from native libraries to file specified.

coreMeetingTraceOutputHistory

open fun coreMeetingTraceOutputHistory(filename: String)

Write CoreMeeting/MeetingSDK log messages from native libraries to file specified.

deleteAllLogFiles

open fun deleteAllLogFiles(): Boolean

Delete all .

deleteLogFile

open fun deleteLogFile(fileName: String): Boolean

Delete the specified log file.

destroySDK

open fun destroySDK()

Cleans up low level audio and video.

disableAudioInput

open fun disableAudioInput(): Boolean

Disables the input microphone for the device.

open fun disableAudioInput(deviceName: String): Boolean

Disables the input microphone for the specfied device.

disableAudioInputPreview

open fun disableAudioInputPreview(device: String): Boolean

Disables (stops) preview mode for Audio Input.

disableAudioOutput

open fun disableAudioOutput(): Boolean

Disables the audio output for the last device enabled , essentially muting all other participants in the meeting.

open fun disableAudioOutput(deviceName: String): Boolean

Disables the audio output for the specified device, essentially muting all other participants in the meeting.

disableAudioOutputPreview

open fun disableAudioOutputPreview(device: String): Boolean

Disables preview mode for Audio Output.

disableImageCapture

open fun disableImageCapture(deviceId: Int): Boolean

disableNetworkVideo

open fun disableNetworkVideo(url: String): Boolean

Disables streaming video from a network camera.

disableScreenCapture

open fun disableScreenCapture(): Boolean

Stops capturing local screen.After disabling capture, the application will receive a notification that the stream has been removed and can remove its container view.Please see the FAQ section on "Screen Sharing" for further instructions.

disableVideoCapture

open fun disableVideoCapture(deviceName: String): Boolean

Stops capturing local video.After disabling capture, the application will receive a notification that the stream has been removed and can remove its container view.

disableVideoPreview

open fun disableVideoPreview(deviceName: String): Boolean

Stops local video preview for specified device

disableVideoStream

open fun disableVideoStream(streamId: String): Boolean

Disables showing the participant's video stream.A disabled stream will not show up again until re-enabled.

enableActiveLogging

open fun enableActiveLogging(filename: String)

enableActiveLoggingSet whether or not you'd like all log messages to be written to a file as they come in.

enableAudio

open fun enableAudio(): Boolean

Enables both audio input and output for your device.

enableAudioInput

open fun enableAudioInput(deviceName: String): Boolean

Enables the input microphone for the device.

enableAudioInputPreview

open fun enableAudioInputPreview(device: String): Boolean

Enables preview mode for Audio Input.

enableAudioOutput

open fun enableAudioOutput(deviceName: String): Boolean

Enables the audio output for the device, allowing the local participant to hear other participants in the meeting.Must be one of the device names returned by getAudioOutputDevices.

enableAudioOutputPreview

open fun enableAudioOutputPreview(device: String, soundPath: String): Boolean

Enables preview mode for Audio Output.

enableCombinedLogs

open fun enableCombinedLogs(enable: Boolean)

enableCombinedLogsSet whether or not you'd like IGAudio/IGVideo/CoreMeeting/MeetingSDK log messages to all be returned (and possibly buffered)to the same location

enableImageCapture

open fun enableImageCapture(displayName: String, directory: String, mode: String): Int

enableLogForwarding

open fun enableLogForwarding(enable: Boolean)

enableLogForwardingSet whether or not you'd like IGAudio/IGVideo messages to be returned to you a line at a time via the INotificationCallback onLogMessage method.

enableNetworkVideo

open fun enableNetworkVideo(url: String, resolution: String, name: String): Boolean

Enables streaming video from a network camera.

enableScreenCapture

open fun enableScreenCapture()

open fun enableScreenCapture(deviceName: String, resolution: String): Boolean

Enables sharing local device screen with desired resolution.

enableVideoCapture

open fun enableVideoCapture(deviceName: String, resolution: String, blurring: Boolean): Boolean

Enables video to be captured and shared in meeting on specified device using the specified resolution.

enableVideoPreview

open fun enableVideoPreview(deviceName: String, resolution: String): Boolean

Enables a video preview on specified device using the specified resolution and NO blurring.

open fun enableVideoPreview(deviceName: String, resolution: String, enableBlurring: Boolean): Boolean

Enables a video preview on specified device using the specified resolution.

enableVideoStream

open fun enableVideoStream(participant: Participant, streamId: String): Boolean

Enable showing the participant's video stream.Whenever a new video stream becomes available in the meeting, the application will receive a notification of a new participant stream.The stream must be enabled by application using this function before it can be displayed on screen.

exitMeeting

open fun exitMeeting()

Exit meeting and clean up any resources allocated.

findParticipantByUUID

open fun findParticipantByUUID(uuid: String): Participant

Returns a Participant object corresponding to the passed UUID, null otherwise

flushCurrentLogFile

open fun flushCurrentLogFile(): Boolean

Forces any current buffered log messages to be written to the current log file

getAudioInputDevices

open fun getAudioInputDevices(devices: ArrayList<String>): String

Returns a list of the available local audio input devices.

getAudioOutputDevices

open fun getAudioOutputDevices(devices: ArrayList<String>): String

Returns a list of the available local audio output devices.

getLocalParticipant

open fun getLocalParticipant(): Participant

Retrieve the local participant, the user of device - this can be called anytime after joinMeeting returns successfully.

getLogFiles

open fun getLogFiles(logFiles: ArrayList<String>): Boolean

Retrieve an array of all the log files (.

getParticipantByAudioStreamId

open fun getParticipantByAudioStreamId(streamId: String): Participant

Retrieve meeting participant using a audio streamId.

getParticipantByVideoStreamId

open fun getParticipantByVideoStreamId(streamId: String): Participant

Retrieve meeting participant using a video streamId.

getParticipants

open fun getParticipants(): ArrayList<Participant>

Retrieves list of participants in meeting.

getSupportedVideoSendResolutions

open fun getSupportedVideoSendResolutions(deviceName: String): Array<String>

Retrieves codecs/resolutions supported by the device name specified

getTimeZone

open fun getTimeZone(): String

Returns the current time zone ID

getVideoDevices

open fun getVideoDevices(devices: ArrayList<String>, screens: ArrayList<String>)

Gets available video devices.

getVideoInfoByStreamId

open fun getVideoInfoByStreamId(streamId: String): VideoInfo

Retrieve VideoInfo using a video streamId.

imageCapturePutImage

open fun imageCapturePutImage(deviceId: Int, imageBuffer: Array<Byte>, width: Int, height: Int, size: Int): Boolean

initializeSDK

open fun initializeSDK(context: Context): Boolean

Creates MeetingSDK singleton and loads native libraries.This must be called before any other SDK methods.

isScreenShare

open fun isScreenShare(streamId: String): Boolean

Returns true if the streamId specified represents a screen share.

joinMeeting

open fun joinMeeting(server: String, meetingUUID: String, key: String, userUUID: String, name: String, joinDoneCallback: IJoinMeetingCompleteCallback)

Adds you as a participant in the meeting and set up your device to connect with audio and video services.Assumes you are connecting to a V2 serverIf method succeeds your application will begin to receive notifications when new participants are added to the meeting,when participant's audio and video streams are available, and when the participants leave the meeting.

joinMeetingWithToken

open fun joinMeetingWithToken(server: String, meetingUUID: String, token: String, userUUID: String, name: String, joinDoneCallback: IJoinMeetingCompleteCallback)

Adds you as a participant in the meeting and set up your device to connect with audio and video services.Assumes you are connecting to a V3 or later serverIf method succeeds your application will begin to receive notifications when new participants are added to the meeting,when participant's audio and video streams are available, and when the participants leave the meeting.

joinMeetingWithTokenAndJWT

open fun joinMeetingWithTokenAndJWT(server: String, meetingUUID: String, token: String, jwt: String, name: String, joinDoneCallback: IJoinMeetingCompleteCallback)

logMemoryStats

open fun logMemoryStats(when: String)

pauseVideoFrameProcessing

open fun pauseVideoFrameProcessing(streamId: String)

Pauses video frame processing for the given stream id.

playSound

open fun playSound(soundBytes: Array<Byte>, len: Int): Long

Plays sound (WAV data) through underlying Audio library (takes advantage ofecho cancellation logic)

resetCurrentLogFile

open fun resetCurrentLogFile(): Boolean

Remove all logging entries from the current log file, but allow future logging to continue into the file

resumeVideoFrameProcessing

open fun resumeVideoFrameProcessing(streamId: String)

Resumes video frame processing for the given stream id.

screenCaptureCancelled

open fun screenCaptureCancelled()

called by ScreenShareActvity when user cancelled request to share

sendLogMessage

open fun sendLogMessage(message: String)

setAudioInputVolume

open fun setAudioInputVolume(volume: Int): Boolean

Sets audio input volume for device.Currently not implemented on Android or IOS and will always return false.

setAudioOutputVolume

open fun setAudioOutputVolume(volume: Int): Boolean

Sets audio output volume for device.Currently not implemented on Android or IOS and will always return false.

setAudioStreamVolume

open fun setAudioStreamVolume(streamID: String, volume: Int): Boolean

Adjusts the volume for the provided audio stream.

setDelegate

open fun setDelegate(@Nullable() delegate: MeetingSDKDelegate)

Sets the delegate class instance (implementation of INotificationCallback protocol)to be used to receive messages from SDKMessages will be received in the thread managed by JNI C++ code

open fun setDelegate(@Nullable() delegate: MeetingSDKDelegate, looper: Looper)

Sets the delegate class instance (implementation of INotificationCallback protocol)to be used to receive messages from SDKMessages will be received in the thread managed by passed Looper object

setDeviceRotation

open fun setDeviceRotation()

Method to notify SDK that device has changed its orientation.The SDK will determine the device's current rotation.

setLogDirectory

open fun setLogDirectory(path: String): Boolean

Set the directory to which active logging will take place.

setTraceLevel

open fun setTraceLevel(level: MeetingSDK.DebugLevel)

setTraceLevelSets the trace debug level for both audio, video and CoreMeeting libraries

stopSound

open fun stopSound(id: Long): Boolean

Stops playback of sound currently being played with specified id