ITrueConfCallX Interface Reference

Accept incoming call. Could be executed only when incoming call or group conference invite is in process, ignored otherwise

See also

acceptPeer

Allow user to join your group conference. Could be executed only when incoming request for joining conference is in process, ignored otherwise. Moderator rights for current conference are required.

Parameters

peerId

– TrueConf ID of user

See also

accept

Accept invitation to take podium. Could be executed only when incoming request for taking podium is in process, ignored otherwise.

Allow user to take podium. Could be executed only when incoming request from user for taking podium is in process, ignored otherwise. Moderator rights for current conference are required.

Activate license key

Parameters

licenseKey

– license key

Add contact to user address book

Parameters

callId	– TrueConf ID of user to add
displayName	– Display Name of added user

Add user to address book

Parameters

peerId	– user ID
displayName	– user display name

Returns

json string with return result

Add user to group

Parameters

groupId	– group ID
peerId	– user ID

Returns

json string with return result

Allow your video/audio stream recording Could be executed only when incoming request on stream recording is in process, ignored otherwise.

See also

denyRecord

Start application update After successful update conference will be restarted

Ban user

Parameters

peerId

– user ID

Returns

json string with return result

Call user or join the conference by CID. This command starts p2p call or joins the conference. This command starts p2p call.

Parameters

peerId

– user TrueConf ID or alias, or other supported ID types (H323, SIP, RTSP) in correct format, or conference CID in correct format ([conference name]@[server name]#vcs).

See also

reject

Set videomatrix type and peer plasec Command is available in group conference, ignored otherwise

Parameters

jsonMatrix

– videomatrix data in JSON format { “matrixType” : 1, “participants” : [ { “slotId” : 1, “peerId” : “jonh@trueconf.com” }, { “slotId” : 2, “peerId” : “ivan@trueconf.com” }, { “slotId” : 3, “participant” : “lee@trueconf.com” } ] }

Clear chat history

Parameters

chatId

– chat ID, peerId of party for pesonal chats or group conference ID

Returns

json string with return result

Connect to server

Parameters

serverStr

– specify server IP address or DNS name in format server.name[:port], for example “video.company.com:4307” port number is optional, default port number 4307 is used if omitted use empty string to connect to TrueConf Online cloud use .name to connect to other cloud

See also

OnServerConnected

OnServerDisconnected

Create conference with specific parametes

Parameters

confName	– conference name
type	– Conference type. One of “symmetric” “asymmetric” “role”
autoAccept	– allow users to join automatically
users	– user ID list to invite. TrueConf ID and H323,SIP, RTSP ID’s could be used in special format

Create group

Parameters

name	– group name

Returns

json string with return result

Show first slide Command could be executed only in process of slideshow

Deny recording request of your stream Could be executed only when incoming request on stream recording is in process, ignored otherwise.

Send address book request to server

Get application state

Get audio mute state

Get ban list

Returns

json string with return result

(TODO translate) get call history list

Parameters

count

– requested calls count, it should be more than one return json string that contains call history list

See also

OnCallHistoryUpdated

Get latest chat messages

Parameters

chatId	– chat ID, peerId of party for pesonal chats or group conference ID
count	– message count

Returns

json string with return result and message list

Get detailed user information

Parameters

peerId

– user’s TrueConf ID

Get user display name from TrueConf ID.

Parameters

peerId

– user’s TrueConf ID

Get group information

Returns

json string with return result

Get hardware list

Get unique hardware key for license generation

Get list of all users requesting to enter conference

Get current license information

Get chat list

Returns

json string with chat list

Get maximum conference title length

Get audio input mute information

Get modes and pins for current camera device

Get system screen infromation

Get conference participants list

Get settings

Get slideshow information

Get system information

Get video matirx information

Get video mute state

Send request to take podium. Moderators take podium automatically

See also

onRoleEventOccurred

Leave conference Could be executed only when incoming request on stream recording is in process, ignored otherwise.

See also

hangUp2

XHangUpForAll

Leave or terminate conference Could be executed only when incoming request on stream recording is in process, ignored otherwise.

Parameters

forAll

– leave or terminate true – terminate conference for all. Requires moderator rights. false – leave conference

See also

hangUp

XHangUpForAll

Invite user to conference. Requires moderator rights. Could be executed only when incoming request on stream recording is in process, ignored otherwise.

Parameters

peerId

– user ID

Invite user to podium. Command is valid for role-based conference only. Requires moderator rights. Could be executed only when incoming request on stream recording is in process, ignored otherwise.

Parameters

peerId

– user ID

Show last slide Command could be executed only in process of slideshow

Leave podium. Command is valid for role-based conference only. Could be executed only when incoming request on stream recording is in process, ignored otherwise.

Authorize on server

Parameters

login	– User ID
password	– Use password

See also

logout

Deauthorize from server

See also

login

Move slide down in list Command could be executed only in process of slideshow

Parameters

slideIdx

– slide index to move

Move slide up in list Command could be executed only in process of slideshow

Parameters

slideIdx

– slide index to move

Show next slide Command could be executed only in process of slideshow

Show previous slide Command could be executed only in process of slideshow

Turn camera down. Use ptzStop command to stop the operation. PTZ camera control

Turn camera left. Use ptzStop command to stop the operation. PTZ camera control

Turn camera right. Use ptzStop command to stop the operation. PTZ camera control

Stop camera rotation and zoom.

Turn camera up. Use ptzStop command to stop the operation. PTZ camera control

Increase camera zoom. Use ptzStop command to stop the operation. PTZ camera control

Decrease camera zoom. Use ptzStop command to stop the operation. PTZ camera control

reject incoming call or conference invite Command could be executed onlye when request is in process/

See also

accept

reject invitation to take podium

reject request to join conference

Parameters

peerId

– User ID

reject request to take podium

Remove user from address book

Parameters

callId

– User ID

Delete user from address book

Parameters

peerId

– user ID

Returns

json string with return result

Remove user from group

Parameters

groupId	– group ID
peerId	– user ID

Returns

json string with return result

Remove user from podium. Command is valid for role-based conference only. Requires moderator rights. Could be executed only when incoming request on stream recording is in process, ignored otherwise.

Parameters

peerId

– user ID

Delete group

Parameters

groupId

– group ID

Returns

json string with return result

Remove user from conference. Requires moderator rights. Could be executed only when incoming request on stream recording is in process, ignored otherwise.

Parameters

peerId

– user ID

Rename group

Parameters

groupId	– group ID
newGroupName	– new group name

Returns

json string with return result

Rename user in address book

Parameters

peerId	– user ID
newDisplayName	– new user’s display name

Returns

json строка с результатом выполнения

send command to a user, the user will receive onCommandReceived event

Send message to current group conference

Parameters

message

– message

Returns

json string with return result

Send message to user

Parameters

peerId	– user ID
message	– message

Returns

json string with return result

Mute/unmute audio output

Set current hardware

(TODO translate) mark all calls in call history as “viewed”, update lastView parameter (see OnCallHistoryUpdated) return json string with the result of the command execution

See also

OnCallHistoryUpdated

Select audio input mute state

Set mode and pin of current camera device

Set application settings

Mute/unmute video

Show slide by index Command could be executed only in process of slideshow

Shutdown application

Shutdown application with options

Parameters

forAll

– if true, terminates conference for all users

Start remark. Available in role-based conference only. Fails if other user remark is in process. After positive reponse 5 seconds coundown starts onRemarkCountDown will be called each second

See also

onRemarkCountDown

Start screen or application sharing

Parameters

id	– screen or window handle

Starts slideshow. Slides should be uploaded prevoiusly

Parameters

slideShowName

– Slideshow name, could be empty

See also

stopSlideShow

Stop screen or application sharing.

Stop slideshow Command could be executed only in process of slideshow

See also

startSlideShow

Request video/content stream switch

Parameters

peerId	– user ID
mainCamera	– content flag true – main stream false – content stream

take screen shot of the callx

Parameters

outputFileName

– file name for screen shot output file

Starts audio capture test

Returns

json string with return result

Stops audio capture test

Returns

json string with return result

Starts audio playback test

Returns

json string with return result

Send DTMF dial tones in video call

Parameters

symbol

– tone to send

Returns

json string with return result

Unban user

Parameters

peerId

– user ID

Returns

json string with return result

Adds slide to slideshow

Parameters

imgPath

– full image path

Open slide select dialog for slideshow

Returns

returns 0 if ok or error code

Check if event exists Helper function that can check which event was triggered in OnXNotify

Parameters

notificationData	– data passed in OnXNotify
eventName	– event name

Returns

returns true, if eventName exists in notificationData

Do not use camera

See also

XSelectCamera

Camera

Do not use audio input (microphone)

See also

Microphone

Do not use audio output (speaker)

See also

Speaker

Execute command in text format

Parameters

cmd	– command text

Start file transfer

Delete file uploaded before

Parameters

fileID

– file id , use 0 to delete all files

Reject file transfer request

Send file

Cancel file transfer

Send file to all group conference participants

Parameters

filePath	– full file path
fileCaption	– file name

Returns

file ID

Get file transfer progress and statistics

Check if file transfer is available

Restart terminal options

Get CallX process ID

Returns camera name by index

Parameters

cameraIdx

– camera index in list camera indexes start from 0.

Returns number of cameras in system

Get camera list

Returns

List of camera names that are present in system. Multilite text separated by “\r\n” newline symbols

See also

Camera

XGetSpeakerList

XGetMicList

XSetCameraByIndex

XGetCameraCount

(TODO translate) get full path of downloaded file

(TODO translate) get hash by file id

(TODO translate) get file id by hash

Get file status (if id != 0) or get common file transfer information (id == 0)

Parameters

id	– file id or 0 for common information

Returns

– file transfer status

• 1 – start error
• 2 – started
• 3 – complete
• 4 – undefined error while sending
• 5 – pending
• 0 – if id != 0 – id not found
• 0 – if id == 0 – no files in queue
• 255 -there are files in queue (только если id == 0)
• -1 – file transfer not available
• -2 – unknown error

Get list of all files in FileTransfer Each list item contains the following information

Parameters

id	– file id
isForSent	– file transfer direction: true – sending, false – receiving
fileName	– file name, name without path while receiving, full path while sending
caption	– file caption
peerId	– peerId of sender
downloadDir	– folder for file download (while receiving)
hash	– file hash

Get CallX window handle

Returns

returns window handle, positive value, can be used for screen shot making

Get audio input name by index

Parameters

micIdx

– audio input device index in list

See also

Microphone

Get audio input devices count in system

See also

Microphone

Get audio input (microphone) device list

Returns

List of audio input device names that are present in system. Multilite text separated by “\r\n” newline symbols

See also

Microphone

XGetSpeakerList

XGetCameraList

Get audio output name by index

Parameters

speakerIdx

– audio output device index in list

See also

Speaker

Get audio output devices count in system

See also

Speaker

Get audio output input (speaker) device list

Returns

List of audio output device names that are present in system. Multilite text separated by “\r\n” newline symbols

See also

Speaker

XGetCameraList

XGetMicList

Terminate conference for all participants. Moderator rights for current conference are required

See also

hangUp

hangUp2

Print local file

Print file on conference party side, file should be previously uploaded by party.

Deletes slide from slideshow

Parameters

imgIdx

– slide index in list

Restarts application window. Sends shutdown command and starts new instance wihtour waitng for answer

See also

XRestartForce

Select camera by name

Parameters

cameraName

– Camera name

See also

Camera

XDeselectCamera

Select audio input device by index

Parameters

micIdx

– audio input device index in list

• audio input will be set to none if audio input with such index does not exist
• indexes start from 0.

  See also

  Microphone

Select audio output device by index

Parameters

speakerIdx

– audio output device index in list audio output will be set to none if audio output with such index does not exist indexes start from 0.

See also

Speaker

Set background image for main component window

Parameters

imgPath

– full path to image file

Select camera by index

Parameters

cameraIdx

– camera index in list

• camera will be set to none if camera with such index does not exist
• cameraIdx >= 0.

Initiates picture broadcast in place of video from camera.

Parameters

imgPath

– Full path of image file

See also

XStopBroadcastPicture

Stop picture broadcast, send video from camera

See also

XStartBroadcastPicture

Full path to executable used by TrueConf CallX. Initialized from registry by default. Used when executable is started.

Get current camera name

See also

XSelectCamera

XDeselectCamera

XGetCameraList

Get audio input (microphone) device name

Get audio output (speaker) device name