Add a Source to a Session
This command adds a source to a session specified by the session ID. You specify the source using the source ID.
Tip
The source ID is generated by HMP when the source is defined. To add a source to a session, go the Web interface (
Note
To create a multi-source session, you simply add up to four sources to a session, executing the addSourceToSession command once for each source you wish to add.
Authorizations: All
Requests
addSourceToSession sessionId sourceId |
Parameters
| Parameter | Description/Values |
|---|---|
sessionId | The ID of a HMP session. |
sourceId | The ID of a HMP source. See the Tip above to obtain the desired source ID. |
Result
Success
OK |
Error
| Error | Description |
|---|---|
ERROR|010003|Expected 2 parameter(s). | Calling addSourceToSession requires 2 parameters. |
ERROR|010001|'Y' is not a UUID | The sessionId provided was not a valid UUID. OR The sourceId provided was not a valid UUID. |
ERROR|060003|Active recording currently | The session is being recorded. All recordings for this session must be stopped before a source can be added. |
ERROR|070010|Could not create a track | Attempting to create a track for the source failed. |
ERROR|040006|Session not found | The 'session' with UUID 'sessionId' was not found. |
ERROR|040009|Source not found | The 'source' with UUID 'sourceId' was not found. |
ERROR|060008|Source already added to this | The source with UUID 'sourceId' has already been added to this session. |
Example
The following example adds a source to the session specified by ID 71edd346-2cf0- 4c62-b3d3-9d457b287394. The system returns OK.
addSourceToSession 71edd346-2cf0-4c62-b3d3-9d457b287394 OK |