Recommended Method for Working with Profiles - 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.

Recommended Method for Working with Profiles

The body of a POST or PUT profile request can contain a lot of elements (attributes of the profile). We recommend that you follow the procedures in this section to create the body.

Create a Profile Base

  1. Use the AWS Elemental Conductor Live 3 web interface to create a profile that contains most of the content you want:

    • The desired inputs, including the desired number and types of video, audio, and caption streams as well as the desired hot backup fields.

    • The desired output groups.

    • Within each output group, the desired outputs.

    • Within each output, the desired video, audio and captioning.

    Give the profile a descriptive name, perhaps including the term “template” and including a description of the inputs, outputs, codecs used, and so on.

    See the AWS Elemental Conductor Live 3 User Guide for information on the contents of a profile.

  2. Do a GET Profile List and make a note of the ID for this profile.

Create a Template

  1. Use the GET Profile command to get this profile with the clean parameter set to true. For example, to get the profile that has the ID 2, use this command.

    GET http://198.51.100.0/profiles/2.xml?clean=true

    The response removes the ID, which makes it valid for re-use in a POST or PUT.

  2. Inspect the XML document that is returned. You will notice that it is structured as shown below.Make sure that it has all the information that you want in the template.

  3. You can now store this XML as a template and re-use it in the body of a POST.

Re-use the Template

Templates can be used for current version of AWS Elemental Conductor Live 3 up to two major versions back. When the profile is uploaded, it is migrated to the current version with field selections and values maintained.

  1. To re-use the template, you must:

    • Change the <name>. This name must be unique.

    • Change the <permalink>. This must be the <name> converted to lowercase and with spaces converted to underscores. For example, if the <name> is “Profile A”, then the <permalink> must be “profile_a”.

    • If you are on version 3.2 or higher, you must enter default values for all channel parameters. For more information, see POST: Create a Profile.

  2. Change any other elements, as desired. Include this XML in the body of a POST or PUT request. For more information, see POST: Create a Profile.

XML Structure of a Profile

<profile href=> //information about the profile and AWS Elemental Conductor Live 3 product and version <name>aa</name> <permalink>bb</permalink> <description>cc</description> <input> . . . <network_input> . . . </network_input> <video_selector> //one or more . . . </video_selector> <audio_selector> // one or more . . . </audio_selector> . . . <caption_selector> // zero or more . . . </caption_selector> . . . <stream_assembly> //one or more <video_description> . . . <h264_settings> //where h264 could be the name of any codec . . . </h264_settings> . . . </video_description> <audio_description> . . . <aac_settings> //where aac could be the name of any audio codec . . . </aac_settings> . . . </audio_description> </stream_assembly> <output_group> <archive_group_settings> //where "archive" could be any output group type . . . </archive_group_settings> <output> . . . </output> </output_group> </profile>