Haivision Media Platform

Summary of Command Line API Commands

Command

Result

Use to…

createSession sessionTitle

sessionId

(4.1) Create a Session

setLiveSession sessionID active

None

(4.1) Set Live Session

deleteSession sessionId

None

(4.1) Delete a Session

addSourceToSession sessionId sourceId

None

(4.1) Add a Source to a Session

removeSourceFromSession sessionId sourceId

None

(4.1) Remove a Source from a Session

shareSessionWithUser username permissionId sessionId

None

(4.1) Share a Session with a User

shareSessionWithGroup groupname permissionId sessionId

None

(4.1) Share a Session with a Group

updateSessionMetadata sessionId title | description | createdby value

None

(4.1) Update Session Metadata

setSessionCategory sessionId categoryId value [value...]

None

(4.1) Set Session Category

startRecording sessionId

recordingId

(4.1) Start a Recording

pauseRecording recordingId

None

(4.1) Pause a Recording

resumeRecording recordingId

None

(4.1) Resume a Recording

stopRecording recordingId

None

Stop a Recording

getRecordingStatus recordingId

state

(4.1) Get Recording Status

shareRecordingWithUser username permissionId recordingId

None

(4.1) Share a Recording with a User

shareRecordingWithGroup groupname permissionId recordingId

None

(4.1) Share a Recording with a Group

updateMetadata recordingId title | description | createdby value

None

(4.1) Update Recording Metadata

setCategory recordingId categoryId value [value...]

None

(4.1) Set Recording Category

addHotmark recordingId title

None

(4.1) Add a HotMark

startRestreamRecording recordingId ip port

streamId

(4.1) Start Re-streaming a Recording

stopRestreamRecording streamId

None

(4.1) Stop Streaming a Recording