Passthrough of Live Event POST Commands - AWS Elemental Conductor Live 3

This is version 3.19 of the AWS Elemental Conductor Live 3 documentation. This is the latest version. For prior versions, see the Previous Versions section of AWS Elemental Conductor Live 3 Documentation.

Passthrough of Live Event POST Commands

HTTP Request and Response

Request URL

POST http://<Conductor IP address>/channels/<ID of channel>/live_events/<action>

where:

  • ID of channel is the ID of a channel known to the AWS Elemental Conductor Live 3 API.

  • /live_events/<action> is the command from the AWS Elemental Live API. See the table below for a complete list of commands.

When the command is submitted, the Conductor API determines the Live event that corresponds to the Conductor channel and then submits the appropriately formed command to the Live API.

Action Signature in AWS Elemental Live Signature in AWS Elemental Conductor Live 3
POST /live_events/<id>/activate_input /channels/<ID of channel>/live_events/activate_input
POST /live_events/<id>/adjust_audio_gain /channels/<ID of channel>/live_events/adjust_audio_gain
POST /live_events/<id>/avail_image /channels/<ID of channel>/live_events/avail_image
POST /live_events/<id>/blackout_image /channels/<ID of channel>/live_events/blackout_image
POST /live_events/<id>/bulk_metadata /channels/<ID of channel>/live_events/bulk_metadata
POST /live_events/<id>/cue_point /channels/<ID of channel>/live_events/cue_point
POST /live_events/<id>/motion_image_inserter /channels/<ID of channel>/live_events/motion_image_inserter
POST /live_events/<id>/mute_audio /channels/<ID of channel>/live_events/mute_audio
POST /live_events/<id>/unmute_audio /channels/<ID of channel>/live_events/unmute_audio
POST /live_events/<id>/pause_output /channels/<ID of channel>/live_events/pause_output
POST /live_events/<id>/unpause_output /channels/<ID of channel>/live_events/unpause_output
POST /live_events/<id>/pause_output_group /channels/<ID of channel>/live_events/pause_output_group
POST /live_events/<id>/unpause_output_group /channels/<ID of channel>/live_events/unpause_output_group
POST /live_events/<id>/private_metadata /channels/<ID of channel>/live_events/private_metadata
POST /live_events/<id>/reset_video_buffer_stats /channels/<ID of channel>/live_events/reset_video_buffer_stats
POST /live_events/<id>/rollover_output /channels/<ID of channel>/live_events/rollover_output
POST /live_events/<id>/start_output /channels/<ID of channel>/live_events/start_output
POST /live_events/<id>/start_output_group /channels/<ID of channel>/live_events/start_output_group
POST /live_events/<id>/stop_output /channels/<ID of channel>/live_events/stop_output
POST /live_events/<id>/stop_output_group /channels/<ID of channel>/live_events/stop_output_group
POST /live_events/<id>/time_signal /channels/<ID of channel>/live_events/time_signal
POST /live_events/<id>/timed_metadata /channels/<ID of channel>/live_events/timed_metadata
POST /live_events/<id>/image_inserter /channels/<ID of channel>/live_events/image_inserter
POST /live_events/<id>/image_inserter/input /channels/<ID of channel>/live_events/image_inserter/input
POST /live_events/<id>/prepare_input /channels/<ID of channel>/live_events/prepare_input

Call Header

  • Accept: Set to application/xml

  • Content-Type: Set to application/xml

If you are implementing user authentication, you must also include three authorization headers; see Header Content for User Authentication.

Request Body

Include a request body only if the original AWS Elemental Live command includes a body.Format the body in exactly the same way.

Response

The response repeats back the response received from the Live API, exactly as received from that API.

Example

AWS Elemental Live REST call:

POST http://<Live IP address>/live_events/<ID of event>/mute_audio

AWS Elemental Conductor Live 3 passthrough of this call:

POST http://<Conductor IP address>/channels/3/live_events/mute_audio