Skip to main content

Summary of Command Line API Commands

Command

Result

Use to…

createSession sessionTitle

sessionId

Create a Session

setLiveSession sessionID active

None

Set Live Session

deleteSession sessionId

None

Delete a Session

addSourceToSession sessionId sourceId

None

Add a Source to a Session

removeSourceFromSession sessionId sourceId

None

Remove a Source from a Session

shareSessionWithUser username
permissionId sessionId

None

Share a Session with a User

shareSessionWithGroup groupname
permissionId sessionId

None

Share a Session with a Group

updateSessionMetadata sessionId
 title | description | createdby value

None

Update Session Metadata

setSessionCategory sessionId categoryId
value [value...]

None

Set Session Category

startRecording sessionId

recordingId

Start a Recording

pauseRecording recordingId

None

Pause a Recording

resumeRecording recordingId

None

Resume a Recording

stopRecording recordingId

None

Stop a Recording

getRecordingStatus recordingId

state

Get Recording Status

shareRecordingWithUser username
permissionId recordingId

None

Share a Recording with a User

shareRecordingWithGroup groupname
permissionId recordingId

None

Share a Recording with a Group

updateMetadata recordingId title |
description | createdby value

None

Update Recording Metadata

setCategory recordingId categoryId
value [value...]

None

Set Recording Category

addHotmark recordingId title

None

Add a HotMark

startRestreamRecording recordingId ip port

streamId

Start Re-streaming a Recording

stopRestreamRecording streamId

None

Stop Streaming a Recording

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.