Viz Channel Branding User Guide
Version 5.1 | Published October 26, 2023 ©
GET Channel Settings (Version 2.0)
Get the complete settings for a specific channel. Modifying settings can only be done through Channel Settings in the Viz Channel Branding Client.
Syntax
GET /api/channels/[channel]/settingsRequest
GET /api/channels/test/settings HTTP/1.1Response
HTTP/1.1 200 OKContent-Type: application/vizrt.integrationshubv2+xml; type=channelsettings <inthub:channelSettings xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:inthub="http://www.vizrt.com/integrationshub"> <inthub:refLink rel="self" type="application/vizrt.integrationshubv2+xml; type=channelsettings" href="http://127.0.0.1:9991/api/channels/test/settings" /> <inthub:general> <inthub:setting name="GeneralSettings.BasicSettings.ChannelBasicInfo.ScreenDimension">1920*1080</inthub:setting> <inthub:setting name="GeneralSettings.BasicSettings.ChannelBasicInfo.AspectRatio">16/9</inthub:setting> <inthub:setting name="GeneralSettings.BasicSettings.ChannelBasicInfo.FramesPerSec">25</inthub:setting> <inthub:setting name="GeneralSettings.BasicSettings.ChannelBasicInfo.BroadcastDayStartTime">04:00:00</inthub:setting> <inthub:setting name="GeneralSettings.BasicSettings.TriggeringControl.TimedPlayout">false</inthub:setting> <inthub:setting name="GeneralSettings.BasicSettings.TriggeringControl.TriggerType">Primary Events</inthub:setting> <inthub:setting name="GeneralSettings.BasicSettings.PlaylistDateManagement.AllEventsInOnePlaylist">true</inthub:setting> <inthub:setting name="GeneralSettings.TimezoneSettings.ScheduleTimeZoneId">W. Europe Standard Time</inthub:setting> <inthub:setting name="GeneralSettings.TimezoneSettings.ChannelTimeZoneId">W. Europe Standard Time</inthub:setting> <inthub:setting name="GeneralSettings.DaySwitchOptions.DaySwitchOptions.ActivateDaySwitch">false</inthub:setting> <inthub:setting name="GeneralSettings.DaySwitchOptions.DaySwitchOptions.ActivatePlaylist">00:00:00</inthub:setting> <inthub:setting name="GeneralSettings.DaySwitchOptions.DaySwitchOptions.InsertCleanUp">false</inthub:setting> <inthub:setting name="GeneralSettings.DaySwitchOptions.DaySwitchOptions.TimeBeforeCleanUp">00:00:00</inthub:setting> <inthub:setting name="GeneralSettings.DaySwitchOptions.DaySwitchOptions.InsertInitialize">false</inthub:setting> <inthub:setting name="GeneralSettings.DaySwitchOptions.DaySwitchOptions.TimeBeforeInitialize">00:00:00</inthub:setting> <inthub:setting name="GeneralSettings.AttributeMappings.AttributeMappings.PredefinedDataMappings"></inthub:setting> <inthub:setting name="GeneralSettings.AttributeMappings.AttributeMappings.MetaDataMappings"></inthub:setting> <inthub:setting name="GeneralSettings.PageContentFilling.PageContentFilling.RefreshPageContentOfPlaylist">true</inthub:setting> <inthub:setting name="GeneralSettings.PageContentFilling.PageContentFilling.RefreshPageContentOfRunningPlaylist">false</inthub:setting> <inthub:setting name="GeneralSettings.PageContentFilling.PageContentFilling.SkipRefreshAlreadyPlayedPage">true</inthub:setting> <inthub:setting name="GeneralSettings.PageContentFilling.PageContentFilling.AllowPageToForceMappingForPageContentFilling">false</inthub:setting> <inthub:setting name="GeneralSettings.PageContentFilling.PageContentFilling.PromoServerAddress"></inthub:setting> <inthub:setting name="GeneralSettings.PageContentFilling.PageContentFilling.MaximumNumberOfPagesToRefreshInPlaylist"></inthub:setting> <inthub:setting name="GeneralSettings.PageContentFilling.PageContentFilling.TranslationTables"></inthub:setting> <inthub:setting name="GeneralSettings.PageContentFilling.PageContentFilling.TonightStartTime">21:00:00</inthub:setting> <inthub:setting name="GeneralSettings.Miscellaneous.GeneralPlayoutOptions.AllowItemReplay">true</inthub:setting> <inthub:setting name="GeneralSettings.Miscellaneous.PlaylistOptions.IsAutoExpandRunningElement">true</inthub:setting> <inthub:setting name="GeneralSettings.Miscellaneous.PlaylistOptions.LockViewToRunningPrimaryEvent">false</inthub:setting> <inthub:setting name="GeneralSettings.Miscellaneous.PlaylistOptions.DefaultPrimaryEventDuration">00:10:00:00</inthub:setting> <inthub:setting name="GeneralSettings.Miscellaneous.PlaylistOptions.DefaultLiveEventDuration">01:00:00:00</inthub:setting> <inthub:setting name="GeneralSettings.Miscellaneous.VizOneIntegration.AutoExtractVizOneMetaData">false</inthub:setting> <inthub:setting name="GeneralSettings.Miscellaneous.VizOneIntegration.CreatePlaceholderInVizOne">false</inthub:setting> <inthub:setting name="GeneralSettings.Miscellaneous.DefaultScenes.AutomaticallyTakeLogoPage">false</inthub:setting> <inthub:setting name="GeneralSettings.Miscellaneous.DefaultScenes.LogoScene"></inthub:setting> <inthub:setting name="GeneralSettings.Miscellaneous.DefaultScenes.ErrorScene"></inthub:setting> <inthub:setting name="GeneralSettings.Miscellaneous.DefaultScenes.VideoOnlyScene"></inthub:setting> <inthub:setting name="GeneralSettings.Miscellaneous.QuickTakePages"></inthub:setting> <inthub:setting name="ScheduleImportSettings.GeneralSettings.ChannelName.ChannelName"></inthub:setting> <inthub:setting name="ScheduleImportSettings.GeneralSettings.RemoteHosts.RemoteHosts"></inthub:setting> <inthub:setting name="ScheduleImportSettings.GeneralSettings.AutomaticImportSettings.EnableAutomaticImport">false</inthub:setting> <inthub:setting name="ScheduleImportSettings.GeneralSettings.AutomaticImportSettings.ImportFolder"></inthub:setting> <inthub:setting name="ScheduleImportSettings.GeneralSettings.AutomaticImportSettings.UpdateFolder"></inthub:setting> <inthub:setting name="ScheduleImportSettings.GeneralSettings.ImportOptions.ImportSecondaryAsRef">false</inthub:setting> <inthub:setting name="ScheduleImportSettings.GeneralSettings.ImportOptions.AllowUsingPilotDataServerElement">false</inthub:setting> <inthub:setting name="ScheduleImportSettings.GeneralSettings.ImportOptions.SkipSecondaryEventsExceedingPrimaryDuration">false</inthub:setting> <inthub:setting name="ScheduleImportSettings.GeneralSettings.ImportOptions.TreatDurationTimeCodeAndTimeGivenAsIntegerAsFrameCount">false</inthub:setting> <inthub:setting name="ScheduleImportSettings.MappingSettings"></inthub:setting> <inthub:setting name="ScheduleImportSettings.FilteringOptions.PrimaryEventFiltering"></inthub:setting> <inthub:setting name="ScheduleImportSettings.UpdateSettings.UpdateOptions.AutomaticUpdateMode">Full</inthub:setting> <inthub:setting name="ScheduleImportSettings.UpdateSettings.UpdateOptions.DeleteProcessedFiles">2</inthub:setting> <inthub:setting name="ScheduleImportSettings.UpdateSettings.UpdateOptions.ClearPlayedEvents">00:00:00</inthub:setting> <inthub:setting name="ScheduleImportSettings.UpdateSettings.UpdateOptions.ClearUnplayedEvents">00:00:00</inthub:setting> <inthub:setting name="ScheduleImportSettings.UpdateSettings.UpdateOptions.AllowUpdatesOfRunningPlaylist">false</inthub:setting> <inthub:setting name="ScheduleImportSettings.UpdateSettings.UpdateOptions.LockEditedPageWhenUpdate">true</inthub:setting> <inthub:setting name="ScheduleImportSettings.UpdateSettings.UpdateOptions.RetrieveDateFromRunningPlaylist">false</inthub:setting> <inthub:setting name="ScheduleImportSettings.UpdateSettings.UpdateOptions.CreatePlaylistIfNotExists">false</inthub:setting> <inthub:setting name="ExternalTriggering.GPI.IsEnabled">false</inthub:setting> <inthub:setting name="ExternalTriggering.GPI.GPIDeviceDefinition.BitsPerSecond">19200</inthub:setting> <inthub:setting name="ExternalTriggering.GPI.GPIDeviceDefinition.Port">----</inthub:setting> <inthub:setting name="ExternalTriggering.GPI.GPIDeviceDefinition.StopBits">1</inthub:setting> <inthub:setting name="ExternalTriggering.GPI.GPIDeviceDefinition.DataBits">8</inthub:setting> <inthub:setting name="ExternalTriggering.GPI.GPIDeviceDefinition.Parity">None</inthub:setting> <inthub:setting name="ExternalTriggering.GPI.GPIDeviceDefinition.FlowControl">None</inthub:setting> <inthub:setting name="ExternalTriggering.GPI.GPIDeviceDefinition.BoxType">SRC-8</inthub:setting> <inthub:setting name="ExternalTriggering.GPI.GPIDeviceDefinition.IP"></inthub:setting> <inthub:setting name="ExternalTriggering.GPI.GPIDeviceDefinition.Unit">0</inthub:setting> <inthub:setting name="ExternalTriggering.GPI.GPIDeviceDefinition.SlaveId">0</inthub:setting> <inthub:setting name="ExternalTriggering.GPI.GPIActionsMapping"></inthub:setting> <inthub:setting name="ExternalTriggering.VDCP.IsEnabled">false</inthub:setting> <inthub:setting name="ExternalTriggering.VDCP.VDCP.IsForceExtendedMode">false</inthub:setting> <inthub:setting name="ExternalTriggering.VDCP.VDCP.BitsPerSecond">38400</inthub:setting> <inthub:setting name="ExternalTriggering.VDCP.VDCP.Port">----</inthub:setting> <inthub:setting name="ExternalTriggering.VDCP.VDCP.ByteSize">8</inthub:setting> <inthub:setting name="ExternalTriggering.VDCP.VDCP.ExtraStopBits">1</inthub:setting> <inthub:setting name="ExternalTriggering.VDCP.VDCP.Parity">1</inthub:setting> <inthub:setting name="ExternalTriggering.IntelligentInterface.IsEnabled">false</inthub:setting> <inthub:setting name="ExternalTriggering.IntelligentInterface.IntelligentInterface.BitsPerSecond">19200</inthub:setting> <inthub:setting name="ExternalTriggering.IntelligentInterface.IntelligentInterface.Port">----</inthub:setting> <inthub:setting name="ExternalTriggering.IntelligentInterface.IntelligentInterface.Encoding">UTF-8</inthub:setting> <inthub:setting name="ExternalTriggering.IntelligentInterface.IntelligentInterface.Space">false</inthub:setting> <inthub:setting name="ExternalTriggering.TCP.IsEnabled">false</inthub:setting> <inthub:setting name="ExternalTriggering.TCP.TCP.Port"></inthub:setting> <inthub:setting name="ExternalDataSources.DatabaseConnections.DatabaseConnections.Links"></inthub:setting> <inthub:setting name="ExternalDataSources.UpdateService.UpdateService.HostName">http://localhost:56999</inthub:setting> <inthub:setting name="ExternalDataSources.UpdateService.UpdateService.Take">true</inthub:setting> <inthub:setting name="ExternalDataSources.UpdateService.UpdateService.TakeTimeout">5</inthub:setting> <inthub:setting name="ExternalDataSources.UpdateService.UpdateService.Preview">true</inthub:setting> <inthub:setting name="ExternalDataSources.UpdateService.UpdateService.PreviewTimeout">5</inthub:setting> <inthub:setting name="ExternalDataSources.UpdateService.UpdateService.Update">true</inthub:setting> <inthub:setting name="ExternalDataSources.UpdateService.UpdateService.UpdateTimeout">5</inthub:setting> <inthub:setting name="ExternalDataSources.DatabaseConnections.DatabaseConnections.ConnectionDelay"></inthub:setting> <inthub:setting name="QuickActions"></inthub:setting> </inthub:general> <inthub:mappings> <inthub:mapping xsi:type="inthub:anytextseparator"> <inthub:fileNamePattern>*.txt</inthub:fileNamePattern> <inthub:scheduleFileNameInfo /> <inthub:columnMappings> <inthub:columnMapping mappingReference="" fieldName="channel" /> <inthub:columnMapping mappingReference="$L(3)" fieldName="date" /> <inthub:columnMapping mappingReference="$L(4)" fieldName="time" /> <inthub:columnMapping mappingReference="@dateT@time" fieldName="begin_at" /> <inthub:columnMapping mappingReference="$L(6)" fieldName="duration" /> <inthub:columnMapping mappingReference="$L(5)" fieldName="description" /> <inthub:columnMapping mappingReference="$L(1)" fieldName="event_id" /> <inthub:columnMapping mappingReference="$L(2)" fieldName="event_type" /> <inthub:columnMapping mappingReference="$L(3)" fieldName="secondary_page" /> <inthub:columnMapping mappingReference="$L(4)" fieldName="secondary_timecode" /> <inthub:columnMapping mappingReference="$L(6)" fieldName="secondary_duration" /> <inthub:columnMapping mappingReference="$L(2)" fieldName="secondary_event_id" /> <inthub:columnMapping mappingReference="$L(7)" fieldName="some_metadata" /> <inthub:columnMapping mappingReference="$L(1)" fieldName="secondary_event_type" /> </inthub:columnMappings> <inthub:primaryDateFormat>yyyy/mm/dd</inthub:primaryDateFormat> <inthub:isBroadcastDate>true</inthub:isBroadcastDate> <inthub:primaryEventType>PRIMARY</inthub:primaryEventType> <inthub:secondaryEventType>SECONDARY</inthub:secondaryEventType> <inthub:isDefaultBehavior>False</inthub:isDefaultBehavior> <inthub:ignoreValues>C,B,P</inthub:ignoreValues> <inthub:skipLines /> <inthub:columnSeparator>|</inthub:columnSeparator> <inthub:encodingType>UTF-8</inthub:encodingType> </inthub:mapping> <inthub:mapping xsi:type="inthub:anytextindex"> <inthub:fileNamePattern>*.txt</inthub:fileNamePattern> <inthub:scheduleFileNameInfo /> <inthub:columnMappings> <inthub:columnMapping mappingReference="" fieldName="channel" /> <inthub:columnMapping mappingReference="$L(19,28)" fieldName="date" /> <inthub:columnMapping mappingReference="$L(29,39)" fieldName="time" /> <inthub:columnMapping mappingReference="@dateT@time" fieldName="begin_at" /> <inthub:columnMapping mappingReference="$L(79,89)" fieldName="duration" /> <inthub:columnMapping mappingReference="$L(40,78)" fieldName="description" /> <inthub:columnMapping mappingReference="$L(10,18)" fieldName="event_id" /> <inthub:columnMapping mappingReference="$L(1,7)" fieldName="event_type" /> <inthub:columnMapping mappingReference="$L(23,27)" fieldName="secondary_page" /> <inthub:columnMapping mappingReference="$L(28,38)" fieldName="secondary_timecode" /> <inthub:columnMapping mappingReference="$L(47,57)" fieldName="secondary_duration" /> <inthub:columnMapping mappingReference="$L(1,13)" fieldName="secondary_event_id" /> <inthub:columnMapping mappingReference="$L(90,119)" fieldName="some_metadata" /> <inthub:columnMapping mappingReference="$L(14,22)" fieldName="secondary_event_type" /> </inthub:columnMappings> <inthub:primaryDateFormat>yyyy/mm/dd</inthub:primaryDateFormat> <inthub:isBroadcastDate>true</inthub:isBroadcastDate> <inthub:primaryEventType>PRIMARY</inthub:primaryEventType> <inthub:secondaryEventType>SECONDARY</inthub:secondaryEventType> <inthub:isDefaultBehavior>False</inthub:isDefaultBehavior> <inthub:ignoreValues>C,B,P</inthub:ignoreValues> <inthub:skipLines /> <inthub:encodingType>UTF-8</inthub:encodingType> </inthub:mapping> <inthub:mapping xsi:type="inthub:xml"> <inthub:fileNamePattern>*.xml</inthub:fileNamePattern> <inthub:scheduleFileNameInfo /> <inthub:columnMappings> <inthub:columnMapping mappingReference="" fieldName="channel" /> <inthub:columnMapping mappingReference="" fieldName="ignore" /> <inthub:columnMapping mappingReference="/date/" fieldName="date" /> <inthub:columnMapping mappingReference="/time/" fieldName="time" /> <inthub:columnMapping mappingReference="@dateT@time" fieldName="begin_at" /> <inthub:columnMapping mappingReference="/duration/" fieldName="duration" /> <inthub:columnMapping mappingReference="/time/" fieldName="secondary_timecode" /> <inthub:columnMapping mappingReference="/title/" fieldName="description" /> <inthub:columnMapping mappingReference="/id/" fieldName="event_id" /> <inthub:columnMapping mappingReference="" fieldName="trigger_id" /> <inthub:columnMapping mappingReference="/type/" fieldName="event_type" /> <inthub:columnMapping mappingReference="/id/" fieldName="secondary_page" /> <inthub:columnMapping mappingReference="/duration/" fieldName="secondary_duration" /> <inthub:columnMapping mappingReference="/secondary_type/" fieldName="secondary_event_type" /> </inthub:columnMappings> <inthub:primaryDateFormat>YYYYMMDD</inthub:primaryDateFormat> <inthub:isBroadcastDate>false</inthub:isBroadcastDate> <inthub:primaryEventType>MAIN</inthub:primaryEventType> <inthub:secondaryEventType>SECONDARY</inthub:secondaryEventType> <inthub:isDefaultBehavior>false</inthub:isDefaultBehavior> <inthub:ignoreValues /> <inthub:primaryEventPath>/event/</inthub:primaryEventPath> <inthub:secondaryInsidePrimaryEvents>false</inthub:secondaryInsidePrimaryEvents> <inthub:secondaryEventPath>/event/</inthub:secondaryEventPath> <inthub:channelNodeLocationTakenFromRoot>false</inthub:channelNodeLocationTakenFromRoot> <inthub:dateNodeLocationTakenFromRoot>false</inthub:dateNodeLocationTakenFromRoot> </inthub:mapping> <inthub:mapping xsi:type="inthub:excel"> <inthub:fileNamePattern /> <inthub:scheduleFileNameInfo /> <inthub:columnMappings> <inthub:columnMapping mappingReference="" fieldName="channel" /> <inthub:columnMapping mappingReference="" fieldName="ignore" /> <inthub:columnMapping mappingReference="$B" fieldName="date" /> <inthub:columnMapping mappingReference="$D" fieldName="time" /> <inthub:columnMapping mappingReference="@dateT@time" fieldName="begin_at" /> <inthub:columnMapping mappingReference="$F" fieldName="duration" /> <inthub:columnMapping mappingReference="$D" fieldName="secondary_timecode" /> <inthub:columnMapping mappingReference="$E" fieldName="description" /> <inthub:columnMapping mappingReference="$C" fieldName="event_id" /> <inthub:columnMapping mappingReference="" fieldName="trigger_id" /> <inthub:columnMapping mappingReference="$G" fieldName="event_type" /> <inthub:columnMapping mappingReference="$D" fieldName="secondary_page" /> </inthub:columnMappings> <inthub:primaryDateFormat>YYYYMMDD</inthub:primaryDateFormat> <inthub:isBroadcastDate>false</inthub:isBroadcastDate> <inthub:primaryEventType>MAIN</inthub:primaryEventType> <inthub:secondaryEventType>SECONDARY</inthub:secondaryEventType> <inthub:isDefaultBehavior>false</inthub:isDefaultBehavior> <inthub:ignoreValues /> <inthub:skipRows /> </inthub:mapping> <inthub:mapping xsi:type="inthub:lst"> <inthub:fileNamePattern>*.*</inthub:fileNamePattern> <inthub:scheduleFileNameInfo>DD_MM_YYYY_CCCC</inthub:scheduleFileNameInfo> <inthub:columnMappings> <inthub:columnMapping mappingReference="channel" fieldName="channel" /> <inthub:columnMapping mappingReference="ignore" fieldName="ignore" /> <inthub:columnMapping mappingReference="date" fieldName="date" /> <inthub:columnMapping mappingReference="time" fieldName="time" /> <inthub:columnMapping mappingReference="@dateT@time" fieldName="begin_at" /> <inthub:columnMapping mappingReference="duration" fieldName="duration" /> <inthub:columnMapping mappingReference="" fieldName="timecode" /> <inthub:columnMapping mappingReference="description" fieldName="description" /> <inthub:columnMapping mappingReference="event_id" fieldName="event_id" /> <inthub:columnMapping mappingReference="trigger_id" fieldName="trigger_id" /> <inthub:columnMapping mappingReference="segment" fieldName="segment" /> <inthub:columnMapping mappingReference="event_id" fieldName="ReconcileKey" /> <inthub:columnMapping mappingReference="SOM" fieldName="SOM" /> <inthub:columnMapping mappingReference="effect1" fieldName="effect1" /> <inthub:columnMapping mappingReference="effect2" fieldName="effect2" /> <inthub:columnMapping mappingReference="effect3" fieldName="effect3" /> <inthub:columnMapping mappingReference="secondary_page" fieldName="secondary_page" /> <inthub:columnMapping mappingReference="secondary_timecode" fieldName="secondary_timecode" /> <inthub:columnMapping mappingReference="secondary_event_id" fieldName="secondary_event_id" /> <inthub:columnMapping mappingReference="secondary_trigger_id" fieldName="secondary_trigger_id" /> <inthub:columnMapping mappingReference="event_type" fieldName="event_type" /> <inthub:columnMapping mappingReference="overlay_type" fieldName="overlay_type" /> <inthub:columnMapping mappingReference="@time+@ReconcileKey" fieldName="TimeAndRKey" /> </inthub:columnMappings> <inthub:primaryDateFormat>DD/MM/YYYY</inthub:primaryDateFormat> <inthub:isBroadcastDate>false</inthub:isBroadcastDate> <inthub:primaryEventType>MAIN</inthub:primaryEventType> <inthub:secondaryEventType>SECONDARY</inthub:secondaryEventType> <inthub:isDefaultBehavior>false</inthub:isDefaultBehavior> <inthub:ignoreValues /> <inthub:useReconcileKeyAsHouseId>false</inthub:useReconcileKeyAsHouseId> <inthub:getDateFromSchedule>false</inthub:getDateFromSchedule> <inthub:codePage /> <inthub:useUsd>false</inthub:useUsd> <inthub:usdName /> <inthub:macroName /> </inthub:mapping> </inthub:mappings> <inthub:primaryEventFilters /></inthub:channelSettings> Disallowed Actions
This end-point does not allow POST, PUT or DELETE, and will return a 'HTTP/1.1 405 Method Not Allowed'.