Viz Channel Branding User Guide

Version 5.2 | Published June 05, 2024 ©

GET Channel settings for a channel

Query Integrations Hub for a channels settings and their current values, using REST.

Note: Query /channelsettings to get a full list of channels that have settings available, for proper discovery of the URI used in the example below.

Syntax

GET /channelsettings/[channelname]

Request

GET /channelsettings/Channel1 HTTP/1.1

Response

Example expected reply:

HTTP/1.1 200 OK
Content-Type: application/vizrt.integrationshub+xml; type=channelsettings
<channelsettings xmlns="http://www.vizrt.com/integrationshub">
<title>Channel Settings info for http://localhost:9990/channelsettings/Channel1</title>
<name>Channel1</name>
<link href="http://localhost:9990/channelsettings/Channel1" rel="self" type="application/vizrt.integrationshub+xml; type=channelsettings" />
<settingsversion>4.0.0</settingsversion>
<setting name="GeneralSettings.BasicSettings.ChannelBasicInfo.ScreenDimension">
<value>1920*1080</value>
</setting>
<setting name="GeneralSettings.BasicSettings.ChannelBasicInfo.AspectRatio">
<value>16/9</value>
</setting>
[..]
<setting name="GeneralSettings.BasicSettings.PlaylistDataMapping.ColumnDataMappings">
<value>
<entry attributeName="begin_at" columnName="Begin Time" editable="true" />
<entry attributeName="duration" columnName="Duration" editable="true" name="entry#2" />
<entry attributeName="timecode" columnName="Offset" editable="true" name="entry#3" />
<entry attributeName="description" columnName="Description" editable="true" name="entry#4" />
<entry attributeName="event_id" columnName="Event ID" name="entry#5" />
<entry attributeName="trigger_id" columnName="Media ID" name="entry#6" />
</value>
</setting>
[..]
</channelsettings>