> This page is for Harmonic. > For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://mediakind.ferndocs.com/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://mediakind.ferndocs.com/_mcp/server. # Create a complete Mux Service POST https://device.example.com:443/cluster1/vos-api/mux/v1/services Content-Type: application/json includes pools and destinations Reference: https://mediakind.ferndocs.com/harmonic/api/vos/mux-app-configure/create-complete-mux-service ## Authentication - `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer `, where token is your auth token. ## Request ### Body (application/json) This endpoint expects a com.harmonicinc.vos.mux.model.common.MuxService. - `destinations` (list of com.harmonicinc.vos.app.configure.model.destination.Destination, optional) - `pools` (list of com.harmonicinc.vos.app.configure.model.pool.Pool, optional) - `service` (com.harmonicinc.vos.app.configure.model.service.Service, optional) ## Response ### 200 OK - `destinations` (list of com.harmonicinc.vos.app.configure.model.destination.Destination, optional) - `pools` (list of com.harmonicinc.vos.app.configure.model.pool.Pool, optional) - `service` (com.harmonicinc.vos.app.configure.model.service.Service, optional) ### 201 Created ## Errors ### 400 Bad Request Error Invalid configuration - `any` ### 401 Unauthorized Error Unauthorized - `any` ### 403 Forbidden Error Unauthorized operation - `any` ### 404 Not Found Error Not Found - `any` ## Types ### com.harmonicinc.vos.app.configure.model.destination.Destination - `destinationProfileId` (string, optional) — Unique identifier of destination profile associated to this destination. It is required in multiscreen output - `id` (string, optional) — Unique identifier of a destination in UUID format - `inUse` (boolean, optional) — Every destination has a flag inUse when destination is used in service - `labels` (list of string, optional) — Labels attached to destination for identification - `modifiableByAffiliate` (boolean, optional) — Flag to indicate whether affiliate can modify this destination. Applicable for XOS IRD - `name` (string, optional) — Display name of a destination - `outputs` (list of com.harmonicinc.vos.app.configure.model.destination.Output, optional) — An output is a singular network location for the content processed and output by a service - `type` (enum, optional) — Destination type - Allowed values: `IP`, `MULTISCREEN_IP`, `ORIGIN`, `ATS`, `MPTS`, `OTT_PLAYOUT`, `SDI` ### com.harmonicinc.vos.app.configure.model.pool.Pool - `divitrackIP` (string, optional) — IP address for the divitrack rate message - `divitrackIpNetworkAddress` (string, optional) — Interface address for sending and receiving divitrack messages - `divitrackPoolBitrate` (integer, optional) — Bitrate for the divitrack pool in bps - `divitrackPoolId` (integer, optional) — Divitrack pool id - `divitrackPoolLatencyMode` (enum, optional) — Latency mode for a divitrack pool - Allowed values: `DEFAULT`, `REDUCED`, `EXTENDED` - `divitrackPort` (integer, optional) — Port for the divitrack rate message - `downstreamComplexityIpDelay` (integer, optional) — Network delay for the downstream complexity message - `downstreamIpDelay` (integer, optional) — Downstream network delay - `id` (string, optional) — Unique identifier of a pool. If specified, pool source will not be created automatically (not applicable for /mux/v1/services API). - `labels` (list of string, optional) — Labels attached to a pool for identification - `maxSourcesDelay` (integer, optional) — Maximum sources delay - `muxAddress` (list of string, optional) — IP addresses of the mux - `name` (string, optional) — Display name of a pool - `poolMode` (enum, optional) — Rate mode for the pool - Allowed values: `VBR`, `CBR` - `stcIp` (string, optional) — IP address for the divitrack STC message - `stcPort` (integer, optional) — Port for the divitrack STC message - `upstreamIpDelay` (integer, optional) — Upstream network delay - `useNominalBitrate` (boolean, optional) — Use the provisioned nominal bitrate by user in destination object. If this value is false or absent, nominal bitrate will be determined automatically. (For internal use) ### com.harmonicinc.vos.app.configure.model.service.Service - `profileId` (string, required) — Id of profile used by a service - `addons` (com.harmonicinc.vos.app.configure.model.service.Addons, optional) - `availabilityZone` (string, optional) — Availability zone where the service shall run - `controlState` (enum, optional) — Control state of a service - Allowed values: `ACTIVATED`, `TEST`, `OFF` - `deploymentInformation` (com.harmonicinc.vos.app.configure.model.service.deployment.DeploymentInformation, optional) - `destinationId` (string, optional) — Id of destination connected to a service - `destinationsId` (list of string, optional) — List of destination connected to a service - `dynamicProgramMode` (enum, optional) — Specify the dynamic program mode of a service - Allowed values: `ON`, `OFF` - `extraVideoDelay` (integer, optional) — This overrides the same param in LabWizard profile - `geoRedundancyMode` (enum, optional) — Specify the geographic redundancy mode of a service - Allowed values: `ON`, `OFF`, `AUTO` - `geoRedundancyTimeReference` (enum, optional) — Specify the geographic redundancy time reference of a service - Allowed values: `AUTO`, `VITC` - `id` (string, optional) — Unique identifier of a service in UUID format - `labels` (list of string, optional) — Labels attached to service for identification - `name` (string, optional) — Display name of a service - `orchestrationLabels` (list of com.harmonicinc.vos.app.configure.model.service.OrchestrationLabel, optional) — Labels for service orchestration - `orchestrationNodeSelectors` (list of com.harmonicinc.vos.app.configure.model.service.OrchestrationNodeSelector, optional) — Labels for service node selector - `pauseGeoRedundancy` (boolean, optional) — Declare if Geo redundancy is paused. - `priority` (enum, optional) — Priority of a service (low, normal, high) - Allowed values: `LOW`, `NORMAL`, `HIGH` - `processingParameters` (com.harmonicinc.vos.app.configure.model.service.ProcessingParameters, optional) - `programNum` (integer, optional) — Program number of a service - `redundancyMode` (enum, optional) — Specify the redundancy mode of a service; Service rank will take effect if it's on - Allowed values: `ON`, `OFF` - `sdiAudioFormats` (list of enum, optional) — list of output sdi audio format (maximum 8 audio formats) - Allowed values: `PCM_stereo`, `PCM_5_1`, `Passthrough` - `serviceSources` (list of com.harmonicinc.vos.app.configure.model.service.ServiceSource, optional) — Sources connected to a service - `serviceTrackingMode` (enum, optional) — Specify the service tracking mode of a service - Allowed values: `ON`, `OFF` - `serviceTrackingSetting` (com.harmonicinc.vos.app.configure.model.service.ServiceTrackingSetting, optional) - `serviceType` (enum, optional) — Type of service. Specifies if the SSPE POD should be kept alive after service become OFFLINE - Allowed values: `LIVE`, `LIVE_EVENT` - `sourceFailoverConditions` (list of com.harmonicinc.vos.app.configure.model.SourceFailoverCondition, optional) — Specify type of SourceFailoverCondition of a service - `sourceSwitchSetting` (com.harmonicinc.vos.app.configure.model.service.SourceSwitchSetting, optional) - `subServices` (list of com.harmonicinc.vos.app.configure.model.service.SubService, optional) — Multi Encoding Profiles Sevice ### com.harmonicinc.vos.app.configure.model.destination.Output - `id` (string, required) — Unique identifier of an output in UUID format - `outputType` (enum, required) — Type of the output - Allowed values: `IP`, `ORIGIN`, `HARMONIC_CLOUDLINK`, `ZIXI`, `HSP`, `OTT_PLAYOUT`, `SRT`, `CLOUD`, `ASI`, `SDI`, `ST2110` - `rank` (integer, required) — Priority of output to be used - `redundancyMode` (enum, required) — The output Redundancy mode - Allowed values: `MANDATORY`, `STANDBY`, `DISABLED` - `asiSettings` (com.harmonicinc.vos.app.configure.model.destination.AsiOutput, optional) - `hspSettings` (com.harmonicinc.vos.app.configure.model.destination.HSP_Output, optional) - `ipSettings` (com.harmonicinc.vos.app.configure.model.destination.IP_Output, optional) - `originSettings` (com.harmonicinc.vos.app.configure.model.destination.OriginOutput, optional) - `psiSiTableSpoolingConfig` (list of com.harmonicinc.vos.app.configure.model.destination.PsiSiTableSpoolingConfig, optional) — Settings of PSI/SI table Spooling - `sdiSettings` (com.harmonicinc.vos.app.configure.model.destination.SDI_Output, optional) ### com.harmonicinc.vos.app.configure.model.service.Addons - `affiliateAddon` (com.harmonicinc.vos.app.configure.model.service.AffiliateAddon, optional) - `broadcasterIdAddon` (com.harmonicinc.vos.app.configure.model.service.BroadcasterIdAddon, optional) - `captionsAddon` (com.harmonicinc.vos.app.configure.model.service.CaptionsAddon, optional) - `casAddon` (com.harmonicinc.vos.app.configure.model.service.CasAddon, optional) - `demuxAddon` (com.harmonicinc.vos.app.configure.model.service.DemuxAddon, optional) - `drmAddon` (com.harmonicinc.vos.app.configure.model.service.DrmAddon, optional) - `easPropertiesAddon` (com.harmonicinc.vos.app.configure.model.service.EasPropertiesAddon, optional) - `inputMonitoringAddon` (com.harmonicinc.vos.app.configure.model.service.InputMonitoringAddon, optional) - `irdetoWatermarkAddon` (com.harmonicinc.vos.app.configure.model.service.IrdetoWatermarkAddon, optional) - `kantarSnapWatermarkAddon` (com.harmonicinc.vos.app.configure.model.service.KantarSnapWatermarkAddon, optional) - `liveEventAddon` (com.harmonicinc.vos.app.configure.model.service.LiveEventAddon, optional) - `logoAddon` (com.harmonicinc.vos.app.configure.model.service.LogoAddon, optional) - `muxAddon` (com.harmonicinc.vos.app.configure.model.service.MuxAddon, optional) - `nielsenWatermarkAddon` (com.harmonicinc.vos.app.configure.model.service.NielsenWatermarkAddon, optional) - `operatorActionAddon` (com.harmonicinc.vos.app.configure.model.service.OperatorActionAddon, optional) - `parentalControlAddon` (com.harmonicinc.vos.app.configure.model.service.ParentalControlAddon, optional) - `playoutSettingsAddon` (com.harmonicinc.vos.app.configure.model.service.PlayoutSettingsAddon, optional) - `scheduler360Addon` (com.harmonicinc.vos.app.configure.model.service.Scheduler360Addon, optional) - `scte35SlateAddon` (com.harmonicinc.vos.app.configure.model.service.Scte35SlateAddon, optional) - `slateWatermarkAddon` (com.harmonicinc.vos.app.configure.model.service.SlateWatermarkAddon, optional) - `synamediaWatermarkAddon` (com.harmonicinc.vos.app.configure.model.service.SynamediaWatermarkAddon, optional) - `thumbnailExporterAddon` (com.harmonicinc.vos.app.configure.model.service.ThumbnailExporterAddon, optional) - `timeAdjustment` (com.harmonicinc.vos.app.configure.model.service.TimeAdjustmentAddon, optional) - `timeAdjustmentAddon` (com.harmonicinc.vos.app.configure.model.service.TimeAdjustmentAddon, optional) - `timedEventAddon` (com.harmonicinc.vos.app.configure.model.service.TimedEventAddon, optional) - `trafficAddon` (com.harmonicinc.vos.app.configure.model.service.TrafficAddon, optional) - `videoInsertionAddon` (com.harmonicinc.vos.app.configure.model.service.VideoInsertionAddon, optional) ### com.harmonicinc.vos.app.configure.model.service.deployment.DeploymentInformation - `accountPrefix` (string, optional) — Account prefix - `deploymentId` (string, optional) — Instance deployment id - `deploymentType` (string, optional) — Instance deployment type - `deviceName` (string, optional) — Device name - `platformRegionZone` (string, optional) — Instance platform region zone ### com.harmonicinc.vos.app.configure.model.service.OrchestrationLabel - `key` (string, optional) - `value` (string, optional) ### com.harmonicinc.vos.app.configure.model.service.OrchestrationNodeSelector - `key` (string, optional) - `value` (string, optional) ### com.harmonicinc.vos.app.configure.model.service.ProcessingParameters - `audioProperties` (list of com.harmonicinc.vos.app.configure.model.service.ProcessingParameters_AudioProperties, optional) — Contains the override values for Audio properties that match on the profile for the given service. - `dataProperties` (com.harmonicinc.vos.app.configure.model.service.ProcessingParameters_DataProperties, optional) - `decoderSettings` (com.harmonicinc.vos.app.configure.model.service.DecoderSettings, optional) - `streamConditioning` (enum, optional) — The setting for stream conditioning mode - Allowed values: `AUTO`, `ESAM_CONDITIONING_INFO`, `NONE` - `videoProperties` (com.harmonicinc.vos.app.configure.model.service.ProcessingParameters_VideoProperties, optional) ### com.harmonicinc.vos.app.configure.model.service.ServiceSource - `rank` (integer, optional) — Priority of source to be used - `sourceId` (string, optional) — Id of source connected to a service - `sourceSwitchBufferSize` (integer, optional) — Specify the buffer size (in ms) of source introducing source delay for doing frame synchronized source switch, range from 0 - 20000 ### com.harmonicinc.vos.app.configure.model.service.ServiceTrackingSetting - `outputFollowInputPid` (boolean, optional) — Default to false where the output PID will follow the PID in source configuration or the PID in the labwizard encoding profile if it is defined. When set to true, the output PID will follow the PID in the input stream (ignoring the PID specified in source configuration and labwizard encoding profile). This parameter is ignored (same as false) when serviceTrackingMode is OFF. - `pidOffset` (integer, optional) — Default to 0 and ignored if outputFollowInputPid = false. pidOffset will be applied to the output PID so output PID = input PID + pidOffset when outputFollowInputPid = true. A modulo is applied if input PID + pidOffset is outside the range of 32 to 8175 so if input PID = 8174 and pidOffset = 2, the output PID will be 33. ### com.harmonicinc.vos.app.configure.model.SourceFailoverCondition - `type` (enum, optional) — Specify type of SourceFailoverCondition required to support. Note: PID_MISSING may be set to detect a video missing PID or a video decoding issue - Allowed values: `PID_MISSING`, `PCR_MISSING`, `CC_ERROR`, `SCRAMBLED_PID`, `AUDIO_PID_MISSING`, `CUSTOM_PID_MISSING` ### com.harmonicinc.vos.app.configure.model.service.SourceSwitchSetting - `esamSourceSwitchSetting` (com.harmonicinc.vos.app.configure.model.service.EsamSourceSwitchSetting, optional) - `inactiveSourceHandling` (enum, optional) — Specify the mode to stop decoding the inactive source for source redundancy service. Default is 'e_AUTO' - Fully decode both sources - Allowed values: `e_AUTO`, `e_FULLY_DECODE`, `e_NO_RECEIVE` - `primaryStableTime` (integer, optional) — Specify the time for primary source to be considered stable in seconds, range 60..86400, default 60s. Only applicable when sourceSwitchTrigger is e_PRIMARY_STABLE. - `sourceSwitchTrigger` (enum, optional) — Specify the source switch trigger mode of service. (['e_SOURCE_FAILURE', 'e_ESAM', 'e_MANUAL', 'e_PRIMARY_STABLE'], default is 'e_SOURCE_FAILURE') - Allowed values: `e_SOURCE_FAILURE`, `e_ESAM`, `e_MANUAL`, `e_PRIMARY_STABLE` - `triggerSettings` (com.harmonicinc.vos.app.configure.model.service.TriggerSettings, optional) ### com.harmonicinc.vos.app.configure.model.service.SubService - `profileId` (string, required) — Id of profile used by a service - `addons` (any, optional) - `destinationsId` (list of string, optional) — List of destination connected to a service - `dynamicProgramMode` (enum, optional) — Specify the dynamic program mode of a service - Allowed values: `ON`, `OFF` - `id` (string, optional) — Unique identifier of a service in UUID format - `labels` (list of string, optional) — Labels attached to service for identification - `programNum` (integer, optional) — Program number of a service ### com.harmonicinc.vos.app.configure.model.destination.AsiOutput - `port` (integer, required) — ASI port for the output - `card` (enum, optional) — ASI card for the output - Allowed values: `CARD_1`, `CARD_2`, `CARD_3` - `muteAtStartup` (boolean, optional) ### com.harmonicinc.vos.app.configure.model.destination.HSP_Output - `hspEndpoint` (string, required) — Internal Live ingest endpoint of the destination - `variantPlaylistFileName` (string, required) — Playlist File Name of the destination - `hspEndpointId` (string, optional) — Live ingest endpoint Id of the destination - `publicHspEndpoint` (string, optional) — Public Live ingest endpoint of the destination ### com.harmonicinc.vos.app.configure.model.destination.IP_Output - `cloudOutputSettings` (com.harmonicinc.vos.app.configure.model.destination.CloudOutputSettings, optional) - `cloudSourceOutputSettings` (com.harmonicinc.vos.app.configure.model.destination.CloudSourceOutputSettings, optional) - `cloudlinkGroupId` (string, optional) — Cloudlink Group Id - `cloudlinkId` (string, optional) — Cloudlink Id - `ipAddress` (string, optional) — IP address to send the output - `ipNetworkAddress` (string, optional) — IP Network address - `ipPort` (integer, optional) — IP port to send the output - `labels` (list of string, optional) — Labels attached to IP output for identification - `muteAtStartup` (boolean, optional) — Disable the output (dedicated to the IP output of a mux) - `poolBinding` (com.harmonicinc.vos.app.configure.model.destination.PoolBinding, optional) - `sourcePort` (integer, optional) — Local UDP port for SRT caller mode - `srtOutputSettings` (com.harmonicinc.vos.app.configure.model.destination.SrtOutputSettings, optional) - `zixiOutputSettings` (com.harmonicinc.vos.app.configure.model.destination.ZixiOutputSettings, optional) ### com.harmonicinc.vos.app.configure.model.destination.OriginOutput - `ipNetworkAddress` (string, optional) — IP Network address - `originOutputEndPoints` (list of com.harmonicinc.vos.app.configure.model.destination.OriginOutputEndPoint, optional) — List of end point mapped to packaging profile type ### com.harmonicinc.vos.app.configure.model.destination.PsiSiTableSpoolingConfig - `psiSiTables` (list of com.harmonicinc.vos.app.configure.model.destination.PsiSiTableConfig, optional) — Table of PSI/SI Configuration ### com.harmonicinc.vos.app.configure.model.destination.SDI_Output - `card` (integer, optional) — card index, specify which SDI card will be used to output the stream - `gpio` (com.harmonicinc.vos.app.configure.model.destination.GpioOutput, optional) - `muteOutputOnSignalLoss` (boolean, optional) — mute the SDI output when the input is lost - `port` (integer, optional) — port index, specify which physical port present on the SDI card will be used to output the stream. - `sdiUhdSettings` (com.harmonicinc.vos.app.configure.model.destination.SdiUhdSettings, optional) - `st2110Parameters` (com.harmonicinc.vos.app.configure.model.destination.ST2110_Output, optional) ### com.harmonicinc.vos.app.configure.model.service.AffiliateAddon - `affiliateId` (string, optional) — Id of affiliate ### com.harmonicinc.vos.app.configure.model.service.BroadcasterIdAddon - `origin` (enum, optional) — Id of affiliate - Allowed values: `ATSC`, `USER_DEFINED` ### com.harmonicinc.vos.app.configure.model.service.CaptionsAddon - `captionsInfo` (list of com.harmonicinc.vos.app.configure.model.service.CaptionsAddon_CaptionsInfo, optional) — List of caption info ### com.harmonicinc.vos.app.configure.model.service.CasAddon - `casSystems` (list of com.harmonicinc.vos.app.configure.model.service.CasAddon_CasSystem, required) — List of Conditional Access System - `enable` (boolean, required) — Enable Conditional Access System ### com.harmonicinc.vos.app.configure.model.service.DemuxAddon - `camAddon` (com.harmonicinc.vos.app.configure.model.service.CamAddon, optional) - `demuxType` (enum, optional) — e_DVB: monitoring data will include service name, type and provider extracted from SDT. e_ATSC : monitoring data will include short name and major/minor channel number extracted from VCT. - Allowed values: `e_DVB`, `e_ATSC` - `descramblingKeys` (list of com.harmonicinc.vos.app.configure.model.service.DescramblingKey, optional) — List of descrambling keys associated to a program - `descramblingPrograms` (list of com.harmonicinc.vos.app.configure.model.service.DescramblingProgram, optional) — List of programs to descramble with BISS-CA - `highJitter` (boolean, optional) — Enable support of source with high jitter. As a side effect, it increases the demux latency to 1 second ### com.harmonicinc.vos.app.configure.model.service.DrmAddon - `customKeyRotationTime` (datetime, required) — Custom key rotation start time in UTC, represented in format of yyyy-MM-ddThh:mm:ssZ (e.g. 2021-03-04T12:34:56Z) - `enable` (boolean, required) — Switch for turn on or off DRM - `settings` (list of com.harmonicinc.vos.app.configure.model.service.DrmAddon_DrmSetting, required) — List of DRM Settings ### com.harmonicinc.vos.app.configure.model.service.EasPropertiesAddon - `enableEas` (boolean, optional) — To start/stop EAS (Emergency Alert System) on this service - `groupId` (integer, optional) — Testing Group ID for this service. EAS global activeGroupId test events will run for this if - `stationId` (string, optional) — Station-Id for this service. EAS events are addressed to StationIds ### com.harmonicinc.vos.app.configure.model.service.InputMonitoringAddon - `enable` (boolean, required) — Switch for enabling input monitoring through HSP ### com.harmonicinc.vos.app.configure.model.service.IrdetoWatermarkAddon - `directId` (long, required) — Direct ID for Irdeto watermarking. Range: 1..4294967295 ### com.harmonicinc.vos.app.configure.model.service.KantarSnapWatermarkAddon - `audFileId` (string, optional) — Aud license file id (license with audience name/ID labels) - `channelConfigs` (list of com.harmonicinc.vos.app.configure.model.service.KantarSnapWatermarkChannelConfig, optional) — List of KantarSnapWatermarkChannelConfig for each Audio Profile - `licFileId` (string, optional) — LIC license file id (license to unlock the product SDK) ### com.harmonicinc.vos.app.configure.model.service.LiveEventAddon - `autoGenerateAcquisitionPointId` (boolean, optional) — Indicate whether to auto generate acquisition point ID for live event. false by default - `confidenceMonitoring` (boolean, optional) — Indicate that LiveEvent confidential monitoring is used. false by default - `endTimeInUtc` (string, optional) — Specify live event end time (in UTC). Support only when serviceType is LIVE_EVENT. Time is represented in format of yyyy-MM-ddThh:mm:ssZ - `recording` (boolean, optional) — Indicate that LiveEvent records is used. false by default - `startTimeInUtc` (string, optional) — Specify live event start time (in UTC) to ensure manifest in package output does not contain content earlier than the start time. Support only when serviceType is LIVE_EVENT. Time is represented in format of yyyy-MM-ddThh:mm:ssZ ### com.harmonicinc.vos.app.configure.model.service.LogoAddon - `imageId` (string, required) — Id of an image in the system - `groupMode` (boolean, optional) — Indicate the logo mode : groups, or single logo for all the profiles - `horizontalOffset` (integer, optional) — Horizontal offset relative to placement in pixel - `hourlySchedule` (list of com.harmonicinc.vos.app.configure.model.service.HourlyLogoInsertionEvent, optional) — The schedule to insert logo periodically for each hour - `logosList` (list of com.harmonicinc.vos.app.configure.model.service.LogoAddon_LogoForLogosList, optional) — List of logos to be inserted - `logosListForGroupMode` (list of com.harmonicinc.vos.app.configure.model.service.LogoAddon_LogoForGroupMode, optional) — logo used for the mode group - `placement` (enum, optional) — Image placement - Allowed values: `BOTTOM_LEFT`, `BOTTOM_RIGHT`, `TOP_LEFT`, `TOP_RIGHT` - `verticalOffset` (integer, optional) — Vertical offset relative to placement in pixel ### com.harmonicinc.vos.app.configure.model.service.MuxAddon - `bandwidth` (integer, optional) — Bitrate of output stream in bps ### com.harmonicinc.vos.app.configure.model.service.NielsenWatermarkAddon - `nielsenWatermarkConfig` (list of com.harmonicinc.vos.app.configure.model.service.NielsenWatermarkConfig, optional) — List of NielsenWatermarkConfig for each Audio Profile ### com.harmonicinc.vos.app.configure.model.service.OperatorActionAddon - `muteOperation` (boolean, optional) — Enabled mute/unmute service output ability ### com.harmonicinc.vos.app.configure.model.service.ParentalControlAddon - `callbackServer` (com.harmonicinc.vos.app.configure.model.service.ParentalControlAddon_CallbackServer, optional) - `callbackUrl` (string, optional) — The callback endpoint used to listen on the parental control insertion status - `channelId` (string, optional) — The ID is used by Parental Control API to identify the service - `commandScheduler` (com.harmonicinc.vos.app.configure.model.service.ParentalControlAddon_CommandScheduler, optional) - `hlsID3Pid` (integer, optional) — The HLS parental control ID3 PID ### com.harmonicinc.vos.app.configure.model.service.PlayoutSettingsAddon - `cleanLayers` (list of com.harmonicinc.vos.app.configure.model.service.PlayoutLayer, optional) — List of clean layers (layers without graphic overlays) ### com.harmonicinc.vos.app.configure.model.service.Scheduler360Addon - `channelId` (string, optional) — This ID is used connect Scheduler 360 ### com.harmonicinc.vos.app.configure.model.service.Scte35SlateAddon - `enableVideoSlate` (boolean, optional) — Enable run-time update on video slate (graphicFilename). default = false - `graphicFilename` (string, optional) — Filename of a graphic in the Asset Acquisition App to be used as the slate video - `imageId` (string, optional) — Id of an image in the system to be used as the slate image - `trigger` (enum, optional) — Trigger of scte35 slate insertion mode. - Allowed values: `e_AUTO`, `e_ESAM_ALTERNATE_CONTENT` - `zoneIdentity` (string, optional) — Zone identity of acquisition point. ### com.harmonicinc.vos.app.configure.model.service.SlateWatermarkAddon - `image_a_Id` (string, optional) — Id of an image for generating output with watermark A - `image_b_Id` (string, optional) — Id of an image for generating output with watermark B - `slateWatermarkType` (enum, optional) — Type of Slate Watermark - Allowed values: `e_SLATE_IMAGE`, `e_VIACCESS_ORCA` ### com.harmonicinc.vos.app.configure.model.service.SynamediaWatermarkAddon - `channelId` (string, optional) — Specify channel ID for a specific stream - `watermarkType` (enum, optional) — Get watermark type for synamedia watermark - Allowed values: `e_WATERMARKING`, `e_SEI_INSERTION` ### com.harmonicinc.vos.app.configure.model.service.ThumbnailExporterAddon - `generationInterval` (integer, required) — Wanted generation interval for the thumbnails - `exportPath` (string, optional) — The path to write the Thumbnails - `height` (integer, optional) — Vertical size of the thumbnails - `password` (string, optional) — Credentials for FTP server - `prefix` (string, optional) — Prefix to name the generated thumbnails - `suffix` (enum, optional) — The suffix mode for the thumbnail filenames - Allowed values: `e_TIMESTAMP`, `e_NONE` - `userName` (string, optional) — Credentials for FTP server - `width` (integer, optional) — Horizontal size of the thumbnails ### com.harmonicinc.vos.app.configure.model.service.TimeAdjustmentAddon - `timeAdjInMs` (integer, optional) — Time Adjustment in millisecond ### com.harmonicinc.vos.app.configure.model.service.TimedEventAddon - `callbackServer` (com.harmonicinc.vos.app.configure.model.service.TimedEventAddon_CallbackServer, optional) - `callbackUrl` (string, optional) — The callback endpoint used to listen on the parental control insertion status - `channelId` (string, optional) — The ID is used by Timed Event API to identify the service - `commandScheduler` (com.harmonicinc.vos.app.configure.model.service.TimedEventAddon_CommandScheduler, optional) - `hlsParentalControlID3Pid` (integer, optional) — The HLS parental control ID3 PID - `hlsPeacockEventID3Pid` (integer, optional) — The HLS peacock timed event ID3 PID - `id3MetadataEventPid` (integer, optional) — The Custom ID3 Metadata Event PID for MediaLive-compatible timed metadata - `timedEventType` (enum, optional) — Timed Event type to identify the service - Allowed values: `e_PARENTAL_CONTROL`, `e_PEACOCK_EVENT`, `e_DATE_RANGE_EVENT`, `e_ID3_METADATA_EVENT` ### com.harmonicinc.vos.app.configure.model.service.TrafficAddon - `trafficId` (integer, optional) — Id of traffic system ### com.harmonicinc.vos.app.configure.model.service.VideoInsertionAddon - `dpiTierSetting` (com.harmonicinc.vos.app.configure.model.service.DpiTierSetting, optional) - `esamServiceSetting` (com.harmonicinc.vos.app.configure.model.service.ESAM_ServiceSetting, optional) - `gpiTriggers` (list of com.harmonicinc.vos.app.configure.model.service.GpiTrigger, optional) — Define a list of SCTE-35 messages triggered by GPI ### com.harmonicinc.vos.app.configure.model.service.ProcessingParameters_AudioProperties - `aacHeader` (enum, optional) — By default, aacHeader of the profile is used, or ADTS if aacHeader is not defined in the profile - Allowed values: `e_ADTS`, `e_LATM` - `ac4IframeInterval` (integer, optional) — Range 12..1000 when video frame-rate is 25 or 50 fps, range=14..1000 when video frame-rate is 29.97 or 59.94 fps. By default, ac4IframeInterval of the profile is used - `bitrate` (enum, optional) — Audio bitrate in kbps. Valid values are dependent on the codec, number of channels and sample rate. By default, bitrate of the profile is used. - Allowed values: `e_AUTO_SELECT`, `e_12`, `e_16`, `e_18`, `e_20`, `e_24`, `e_28`, `e_30`, `e_32`, `e_38`, `e_40`, `e_48`, `e_56`, `e_64`, `e_72`, `e_80`, `e_88`, `e_96`, `e_104`, `e_112`, `e_120`, `e_128`, `e_144`, `e_160`, `e_176`, `e_192`, `e_196`, `e_200`, `e_208`, `e_216`, `e_224`, `e_232`, `e_240`, `e_248`, `e_256`, `e_264`, `e_272`, `e_288`, `e_304`, `e_320`, `e_336`, `e_352`, `e_368`, `e_384`, `e_388`, `e_400`, `e_416`, `e_448`, `e_480`, `e_512`, `e_528`, `e_544`, `e_576`, `e_640`, `e_704`, `e_720`, `e_768`, `e_800`, `e_832`, `e_896`, `e_960`, `e_1024` - `channels` (enum, optional) — Valid values are Pass-through, Stereo (all codecs), Mono (all codecs except AAC-HEv2), 5.1 (AAC-LC, HE-AACv1, AC-3, EAC-3, AC-4), 5.1.4 (EAC-3, AC-4). By default, channels of the profile is used - Allowed values: `e_PASSTHROUGH`, `e_STEREO`, `e_MONO`, `e_DOLBY_5_1`, `e_DUAL_MONO`, `e_5_1_4` - `gain` (integer, optional) — Static gain applied to the audio, in dB. Range -20..20. By default, gain of the profile is used. - `languageIndex` (integer, optional) — Applicable when profile is in match-by-language mode. This index will be used to match the language configured in the profile. The audioProperties will apply for the profile's audio track for the matching language index. - `sampleRate` (enum, optional) — Audio sampling in kHz. Valid values are 16 (AAC-LC mono/stereo), 32 (AAC, MP1L2), 44 (AAC mono), 48 (all). By default, sampleRate of the profile is used. - Allowed values: `e_16`, `e_32`, `e_44`, `e_48` - `sourceLabel` (string, optional) — Applicable when the profile is in match-by-label mode. This label will be used to match the label configured in the profile. The audioProperties will apply for the profile's audio track for the matching label. - `targetlevel` (enum, optional) — Applicable when HALC is used (i.e. audioLevelAlgorithm is e_HALC in the profile), or when target level mode is used (i.e. audioLevelAlgorithm is e_StaticGain and targetLevel is not e_None in the profile). In dBFS when audioLevelAlgorithm is e_StaticGain or when alcMode is e_A_WEIGHTING, in LKFS when alcMode is e_ATSC_A85 or e_EBU_R128. e_None, e_m15, e_m16 are not valid values. By default, targetlevel of the profile is used. - Allowed values: `e_None`, `e_m15`, `e_m16`, `e_m17`, `e_m18`, `e_m19`, `e_m20`, `e_m21`, `e_m22`, `e_m23`, `e_m24`, `e_m25`, `e_m26`, `e_m27`, `e_m28`, `e_m29`, `e_m30`, `e_m31` ### com.harmonicinc.vos.app.configure.model.service.ProcessingParameters_DataProperties - `cc608To708Translation` (enum, optional) — e_NEVER : output CEA-708 is the input CEA-708, e_ALWAYS: the input CEA-708 is always ignored and output CEA-708 is generated from input CEA-608, and no input CEA-608 means no output CEA-708 and e_AUTOSENSE : strategy automatically defined. Default behavior depends on STBmode. - Allowed values: `e_AUTOSENSE`, `e_ALWAYS`, `e_NEVER` - `dvbSubBurnIn` (com.harmonicinc.vos.app.configure.model.service.ProcessingParameters_DataProperties_DvbSubBurnIn, optional) - `generateTimecode` (enum, optional) — Enable Timecode Generation. When it is enabled, the generated timecode will replace the timecode in the source and override enableVitcOutput to true. The generated timecode does not works with geo-sync because of up to few hundred ms of inaccuracy. Default is 'e_DISABLED' - Allowed values: `e_DISABLED`, `e_UTC` - `teletextOverSdiOutput` (enum, optional) — The setting for teletext output format. Default is 'e_OP_47' - Allowed values: `e_WST`, `e_OP_47`, `e_OP_42`, `e_SMPTE_2031` ### com.harmonicinc.vos.app.configure.model.service.DecoderSettings - `contributionMode` (boolean, optional) — Enable contribution mode for the decoder - `latency` (com.harmonicinc.vos.app.configure.model.service.Latency, optional) - `st2110AudioLayout` (com.harmonicinc.vos.app.configure.model.service.St2110AudioLayout, optional) ### com.harmonicinc.vos.app.configure.model.service.ProcessingParameters_VideoProperties - `aspectRatio` (enum, optional) — Applicable only for SD resolutions: 576i and 480i. By default the aspectRatio of the profile is used. - Allowed values: `e_16_9`, `e_4_3`, `e_PASSTHROUGH` - `goplenM` (enum, optional) — Mini GOP Length M. By default the goplenM of the profile is used. - Allowed values: `e_AUTO`, `e_IP`, `e_IBP`, `e_IBBP`, `e_IBBBP`, `e_IBBBBBBBP` - `goplenN` (integer, optional) — GOP Length. Range 1..96 inclusive. By default the goplenN of the profile is used. - `gopoption` (enum, optional) — By default the gopoption of the profile is used. - Allowed values: `e_OPEN_FIXED`, `e_OPEN_VARIABLE`, `e_OPEN_CAPPED`, `e_CLOSED_FIXED`, `e_CLOSED_VARIABLE`, `e_OPEN_FIXED_M`, `e_CLOSED_FIXED_M` - `irisVQBoost` (enum, optional) — Improves VQ by adjusting the setting of each video filter based on input frames. By default the irisVQBoost of the profile is used. - Allowed values: `e_DISABLED`, `e_ENABLED` - `latencyOption` (enum, optional) — Valid values are e_LOW, e_REDUCED, e_DEFAULT. By default the latencyOption of the profile is used. - Allowed values: `e_2_5`, `e_3_5`, `e_5_5`, `e_VERY_SHORT`, `e_LOW`, `e_REDUCED`, `e_DEFAULT` - `resolutionHV` (enum, optional) — Defines the horizontal resolution of video. It shall be consistent with the 'resolution' property of the profile. By default, the 'resolutionHV' of the profile is used. - Allowed values: `e_352x480I`, `e_480x480I`, `e_528x480I`, `e_544x480I`, `e_640x480I`, `e_704x480I`, `e_720x480I`, `e_352x576I`, `e_480x576I`, `e_528x576I`, `e_544x576I`, `e_640x576I`, `e_704x576I`, `e_720x576I`, `e_640x720P`, `e_960x720P`, `e_1280x720P`, `e_960x1080I`, `e_1280x1080I`, `e_1440x1080I`, `e_1920x1080I`, `e_960x1080P`, `e_1280x1080P`, `e_1440x1080P`, `e_1920x1080P`, `e_2560x1440P`, `e_3200x1800P`, `e_3840x2160P`, `e_960x540P`, `e_FOLLOW_INPUT` - `stressBias` (enum, optional) — Controls the stress on the encoded content at various bitrates. By default the stressBias of the profile is used. - Allowed values: `e_CLEAN`, `e_BALANCED`, `e_SHARP` ### com.harmonicinc.vos.app.configure.model.service.EsamSourceSwitchSetting - `fallbackTimeout` (integer, optional) — The timeout value (seconds) for ESAM source redundancy safety fallback mechanism, a mechanism to fallback to primary source from secondary source if there is no message from POIS, range from 10 to 300, default value is equal to 120 - `proprietaryScte104VitcMode` (boolean, optional) — Enable using VITC in SCTE-104 for source switching ### com.harmonicinc.vos.app.configure.model.service.TriggerSettings - `ccErrorsThreshold` (integer, optional) — CC error trigger threshold - range 1..10000, default 120 - Switch will occur as soon as we reach this number of CC errors during last CC error window - `ccErrorsWindow` (integer, optional) — CC error trigger window - range 10..3600 seconds, default 60, step 5 seconds - `customPidMissingList` (list of integer, optional) — List of PIDs that will trigger a switch if absent for customPidMissingWindow duration. A PID is considered absent if no packet occurrence, or if PID is not 0, neither a PMT PID, neither referenced by a PMT (ECM excluded). Packet occurrence condition is lifted within 1 second after packet occurrence. Range 0..8191 - `customPidMissingWindow` (integer, optional) — Custom PID missing window in milliseconds. If empty, no custom PIDs will be monitored. Range 1000..60000 ms, step 1000 ms ### com.harmonicinc.vos.app.configure.model.destination.CloudOutputSettings - `channelId` (string, optional) — Cloud channel id - `channelName` (string, optional) — Cloud channel name - `pipeId` (string, optional) — Pipe id - `pipeState` (enum, optional) — LrsPipe state - Allowed values: `OFFLINE`, `RUNNING`, `UNKNOWN` - `protocol` (string, optional) — Protocol - `region` (string, optional) — Region - `regionDisplayName` (string, optional) — Region display name - `srtCloudOutputSettings` (com.harmonicinc.vos.app.configure.model.SrtCloudOutputSettings, optional) - `streamCount` (integer, optional) — StreamCount ### com.harmonicinc.vos.app.configure.model.destination.CloudSourceOutputSettings - `pipeId` (string, optional) — Lrs pipeId - `protocol` (string, optional) — Protocol - `region` (string, optional) — Region - `regionDisplayName` (string, optional) — Region display name ### com.harmonicinc.vos.app.configure.model.destination.PoolBinding - `complexityIp` (string, optional) — IP address for the divitrack complexity message - `complexityPort` (integer, optional) — Port for the divitrack complexity message - `divitrackCircuitId` (integer, optional) — Divitrack circuit Id - `divitrackMaxBitrate` (integer, optional) — Maximum bitrate for the VBR output in bps - `divitrackMinBitrate` (integer, optional) — Minimum bitrate for the VBR output in bps - `divitrackNominalBitrate` (integer, optional) — Nominal bitrate for the VBR output in bps - `divitrackPriority` (enum, optional) — Divitrack priority - Allowed values: `VERY_HIGH`, `HIGH`, `MEDIUM`, `LOW`, `VERY_LOW` - `divitrackStillImageBitrate` (integer, optional) — StillImage bitrate for the VBR output in bps - `noDivitrack` (boolean, optional) — Flag to indicate it is a special statmux destination type that does not run DiviTrack protocol (e.g. Used by DTA service) - `operationMode` (enum, optional) — Divitrack operation mode - Allowed values: `STATMUX_VBR`, `STATMUX_CBR` - `poolId` (string, optional) — Id of the pool associated with this destination - `stillImageDetectionMode` (enum, optional) — Divitrack still image detection mode - Allowed values: `DETECTION_OFF`, `DETECTION_ON` ### com.harmonicinc.vos.app.configure.model.destination.SrtOutputSettings - `bandwidthOverhead` (integer, optional) — Srt bandwidth overhead - `blockingMode` (boolean, optional) — Srt blocking mode - `channelId` (string, optional) — Srt channel id - `channelName` (string, optional) — Srt channel name - `connectionMode` (enum, optional) — SRT connetion establishing mode - Allowed values: `LISTENER`, `CALLER` - `encryptionParam` (com.harmonicinc.vos.app.configure.model.SrtEncryptionParams, optional) - `endpointSettings` (list of com.harmonicinc.vos.app.configure.model.source.ZixiEndPointSetting, optional) — Endpoints used for transmitting SRT stream. - `latency` (integer, optional) — Srt latency - `streamId` (string, optional) - `timeout` (integer, optional) — Srt timeout ### com.harmonicinc.vos.app.configure.model.destination.ZixiOutputSettings - `channelId` (string, optional) — Zixi channel id - `channelName` (string, optional) — Zixi channel name - `encryptionParam` (com.harmonicinc.vos.app.configure.model.destination.ZixiEncryptionParams, optional) - `fecBlockMs` (integer, optional) — Zixi FEC block ms - `fecOverhead` (integer, optional) — Zixi FEC overhead - `latencyMode` (enum, optional) — Zixi latency mode - Allowed values: `ZIXI_LATENCY_STATIC`, `ZIXI_LATENCY_INCREASING`, `ZIXI_LATENCY_DYNAMIC` - `maxLatency` (integer, optional) — Zixi max latency - `password` (string, optional) — Zixi password - `timeout` (integer, optional) — Zixi timeout - `user` (string, optional) — Zixi user ### com.harmonicinc.vos.app.configure.model.destination.OriginOutputEndPoint - `id` (string, required) — Unique identifier of an origin output end point in UUID format - `originOutputProtocol` (enum, required) — Specify the protocol used for origin output - Allowed values: `HTTP`, `HTTPS`, `RTMP`, `RTMPS` - `packagingProfileType` (string, required) — Type of packaging profile defined at lab wizard profile - `absoluteBaseURL` (string, optional) — Absolute base URL in master playlist to reference stream playlist - `alternativeAbsoluteBaseURL` (string, optional) — Alternative cluster absolute base url in master playlist - `alternativePathwayName` (string, optional) — alternative pathway name for content steering - `backup` (com.harmonicinc.vos.app.configure.model.destination.BackupSettings, optional) - `compatibilityMode` (enum, optional) — Compatibility mode. Default to 'STANDARD' if not specified - Allowed values: `STANDARD`, `AKAMAI`, `AKAMAI_MSL5`, `HUAWEI`, `SIMPLE_HTTP`, `S3`, `MEDIASTORE` - `contentSteeringServerURL` (string, optional) — Content steering server url in master playlist - `drm` (com.harmonicinc.vos.app.configure.model.destination.DrmSettings, optional) - `enableAbsoluteURL` (boolean, optional) — Enable absolute URL in master playlist to reference stream playlist - `enableContentSteeringPlaylist` (boolean, optional) — Enable absolute URL in master playlist to reference stream playlist - `fromliveAbsoluteBaseURL` (string, optional) — Fromlive absolute base URL in master playlist to reference stream playlist - `headerAuthName` (string, optional) — Header Authentication Name for origin output - `headerAuthValue` (string, optional) — Header Authentication Value for origin output - `hostname` (string, optional) — IP address or hostname of origin server - `insertPlaylistCustomTag` (boolean, optional) — Enable custom tag in master playlist - `labels` (list of string, optional) — Labels identifier of an output - `localPathwayName` (string, optional) — local pathway name for content steering - `outputMode` (enum, optional) — Output mode for internal output in Origin destionation - Allowed values: `LIVE_AND_TIMESHIFT`, `LIVE_ONLY`, `TIMESHIFT_ONLY` - `password` (string, optional) — Password of origin server - `path` (string, optional) — Path on the origin server to store the output files - `playlistCustomTag` (string, optional) — Custom tag to add in master playlist - `port` (integer, optional) — TCP port of origin server to connect to - `profileName` (string, optional) — Name of packaging profile defined at lab wizard profile. Used to support multiple packaging with same package type. - `publishName` (string, optional) — Publish name for use in internal origin egress URL - `redundancyMode` (enum, optional) — Redundancy mode of the publishing point - Allowed values: `NONE`, `ACTIVE_ACTIVE`, `ACTIVE_STANDBY` - `streamsPerTcpConnection` (enum, optional) — Specify streams per TCP connection - Allowed values: `ONE_STREAM`, `ALL_STREAMS` - `username` (string, optional) — Username of origin server - `variantPlaylistFileName` (string, optional) — Variant Playlist Filename (override Variant Playlist Filename set in LabWizard HLS destination profile) ### com.harmonicinc.vos.app.configure.model.destination.PsiSiTableConfig - `bitrate` (integer, optional) — bitrate - `pid` (integer, optional) — Pid - `psiSiContent` (string, optional) — Base64 encoded PSI content - `psiSiType` (enum, optional) — PSI/SI Type - Allowed values: `PAT`, `PMT`, `SDT`, `NIT`, `EIT`, `TDT` ### com.harmonicinc.vos.app.configure.model.destination.GpioOutput - `enable` (boolean, optional) — Enable the GPIO OON output feature: on SCTE-104 splice_insert with out_of_network_indicator=1, a ~500ms contact closure will start at splice-point. If enableRtn is true, use GPIO ports 1, 3, 5.. for SDI ports 1, 2, 3.. of card 1. Otherwise, use GPIO ports 1, 2, 3.. for SDI ports 1, 2, 3.. of card 1. - `enableRtn` (boolean, optional) — Enable the GPIO Return-To-Network output feature: on SCTE-104 splice_insert with out_of_network_indicator=0 (or...), a ~500ms contact closure will start at splice-point. Use GPIO ports 2, 4, 6.. for SDI ports 1, 2, 3.. of card 1. Ignored if 'enable' is false. - `preroll` (integer, optional) — Preroll in ms: allows to start the contact closure before or after the splice-point. ### com.harmonicinc.vos.app.configure.model.destination.SdiUhdSettings - `sdiUhdType` (enum, optional) — type of the UHD SDI level A output: QUAD-3G or 12G. If null, default is QUAD_3G - Allowed values: `QUAD_3G`, `_12G` - `sdiUhdVariant` (enum, optional) — variant of the QUAD-3G level A output: ST425-5 2SI or ST425-5 Square Division. If null default is ST425-5 2SI - Allowed values: `ST425_5_2SI`, `ST425_5_SQUARE_DIVISION` ### com.harmonicinc.vos.app.configure.model.destination.ST2110_Output - `nmosEnabled` (boolean, optional) — Enable NMOS registration for ST2110 output - `secondaryOutputEnabled` (boolean, optional) — IP port - `st2110OutComponents` (list of com.harmonicinc.vos.app.configure.model.destination.ST2110_Output_St2110StreamComponent, optional) — IP port ### com.harmonicinc.vos.app.configure.model.service.CaptionsAddon_CaptionsInfo - `captionsProvider` (enum, required) — Captions Provider - Allowed values: `e_NCI` - `tcpPort` (integer, required) — TCP port for incoming captions. Supported ports: 20600...20663 ### com.harmonicinc.vos.app.configure.model.service.CasAddon_CasSystem - `accessCriteria` (string, optional) - `casId` (string, optional) - `ecmId` (string, optional) ### com.harmonicinc.vos.app.configure.model.service.CamAddon - `camParameters` (list of com.harmonicinc.vos.app.configure.model.service.CamAddon_CamParameters, optional) ### com.harmonicinc.vos.app.configure.model.service.DescramblingKey - `keyId` (string, required) — Descrambling key associated to a program - `programNum` (integer, required) — Program Number ### com.harmonicinc.vos.app.configure.model.service.DescramblingProgram - `programNum` (integer, required) — Program Number ### com.harmonicinc.vos.app.configure.model.service.DrmAddon_DrmSetting - `drmSystemId` (string, required) — DRM System ID - `originOutputEndPointId` (string, required) — Origin Output EndPoint ID - `resourceId` (string, required) — Resource ID - `useFixedResource` (boolean, optional) — Use fixed DRM Resource or not ### com.harmonicinc.vos.app.configure.model.service.KantarSnapWatermarkChannelConfig - `channelName` (string, optional) — Watermark label name to apply to the channel - `languageIndex` (integer, optional) — Index in match-by-language mode (unused otherwise) - `sourceLabel` (string, optional) — Source label in match-by-label mode (unused otherwise) ### com.harmonicinc.vos.app.configure.model.service.HourlyLogoInsertionEvent - `endMinute` (integer, optional) - `endSecond` (integer, optional) - `startMinute` (integer, optional) - `startSecond` (integer, optional) ### com.harmonicinc.vos.app.configure.model.service.LogoAddon_LogoForLogosList - `imageId` (string, required) — Id of an image in the system - `horizontalOffset` (integer, optional) — Horizontal offset relative to placement in pixel - `placement` (enum, optional) — Image placement - Allowed values: `BOTTOM_LEFT`, `BOTTOM_RIGHT`, `TOP_LEFT`, `TOP_RIGHT` - `uuid` (string, optional) - `verticalOffset` (integer, optional) — Vertical offset relative to placement in pixel ### com.harmonicinc.vos.app.configure.model.service.LogoAddon_LogoForGroupMode - `imageId` (string, required) — Id of an image in the system - `logoSlateGroupLabel` (string, required) — label of the profile group to have logo inserted per profile - `horizontalOffset` (integer, optional) — Horizontal offset relative to placement in pixel - `placement` (enum, optional) — Image placement - Allowed values: `BOTTOM_LEFT`, `BOTTOM_RIGHT`, `TOP_LEFT`, `TOP_RIGHT` - `verticalOffset` (integer, optional) — Vertical offset relative to placement in pixel ### com.harmonicinc.vos.app.configure.model.service.NielsenWatermarkConfig - `languageIndex` (integer, optional) — Audio index used to mapping the languages defined in Configure app's setting, support up to 16 audio tracks, range 1~16 - `nielsenWatermarkProperties` (com.harmonicinc.vos.app.configure.model.service.NielsenWatermarkProperties, optional) - `sourceLabel` (string, optional) — Label of the source stream to be processed ### com.harmonicinc.vos.app.configure.model.service.ParentalControlAddon_CallbackServer - `authentication` (com.harmonicinc.vos.app.configure.model.service.ParentalControlAddon_Authentication, optional) ### com.harmonicinc.vos.app.configure.model.service.ParentalControlAddon_CommandScheduler - `authentication` (com.harmonicinc.vos.app.configure.model.service.ParentalControlAddon_Authentication, optional) - `endpoint` (string, optional) — The endpoint of command scheduler - `triggerRepublishOnEmptySchedule` (com.harmonicinc.vos.app.configure.model.service.ParentalControlAddon_TriggerRepublishOnEmptySchedule, optional) ### com.harmonicinc.vos.app.configure.model.service.PlayoutLayer - `layerId` (integer, required) — Playout graphic layer ID, range: 1..8 ### com.harmonicinc.vos.app.configure.model.service.TimedEventAddon_CallbackServer - `authentication` (com.harmonicinc.vos.app.configure.model.service.TimedEventAddon_Authentication, optional) ### com.harmonicinc.vos.app.configure.model.service.TimedEventAddon_CommandScheduler - `authentication` (com.harmonicinc.vos.app.configure.model.service.TimedEventAddon_Authentication, optional) - `endpoint` (string, optional) — The endpoint of command scheduler - `triggerRepublishOnEmptySchedule` (com.harmonicinc.vos.app.configure.model.service.TimedEventAddon_TriggerRepublishOnEmptySchedule, optional) ### com.harmonicinc.vos.app.configure.model.service.DpiTierSetting - `authorizedDpiTiers` (list of integer, optional) — List of authorized/allowed dpi tiers. Incoming SCTE35 section will not be discarded if it contains one of these tiers. Range: 0-4094 - `blockScte35InputMessages` (boolean, optional) — if set to true, discard all SCTE35 messages, regardless of tier value, except 0xFFF (4095) ### com.harmonicinc.vos.app.configure.model.service.ESAM_ServiceSetting - `acquisitionPointId` (string, optional) — Used to map Signal Aquisition System element to this video service - `passthroughOnInBandDisabled` (boolean, optional) — Enable pass-through of input SCTE35 when in-band ESAM is disabled - `poisEndpoint` (string, optional) — POIS endpoint URL. If not specified, the default POIS endpoint configured in global service settings will be used. - `poisNotifyOnlyMode` (boolean, optional) — Enable the use of ESAM POIS Notify Only mode - `spliceImmediateSpeUtcPointOffset` (integer, optional) — UTC Point Offset to be added to the SPE sent to the ESAM POIS for splice immediate requests in the unit of milliseconds, UTC Point will be [acquisition_time + N] when set to a positive value N, disabled when set to 0 - `timecodeReference` (boolean, optional) — Enable the use of timecode reference for the UTC date in ESAM in-band and OOB messages. The input stream shall contain an UTC-based timecode. - `tlsKeyId` (string, optional) — TLS Key ID to be used to communicate with ESAM POIS - `utcTimeOffset` (integer, optional) — UTC Time Offset to be added to ESAM OOB messages ### com.harmonicinc.vos.app.configure.model.service.GpiTrigger - `delay` (integer, required) — Delay in milliseconds, range [0 - 60000]. For non splice immediate message, the delay is used as a preroll for the SCTE-35 message to be inserted. For splice immediate message, the delay is used to delay the sending of the SCTE-35 message. User should set 0 delay for splice immediate message to be inserted immediately. - `edge` (enum, required) — Define the action of the GPI trigger. e.g. rising or falling edge. - Allowed values: `GPI_RISING`, `GPI_FALLING` - `name` (string, required) — An interface name for GPI box defined in GPI app - `scte35Message` (string, required) — The base64 encoded SCTE-35 message to be inserted. ### com.harmonicinc.vos.app.configure.model.service.ProcessingParameters_DataProperties_DvbSubBurnIn - `enableDvbSubtitleBurnIn` (boolean, optional) — Enable DVB Subtitle BurnIn - `label` (string, optional) — Label identifier of DVB Subtitle data ### com.harmonicinc.vos.app.configure.model.service.Latency - `e2eLatency` (integer, required) — End-to-end latency, in micro-seconds. It should be a multiple of the frame duration (1001000/30) - `enableTcPtpLatency` (boolean, required) — Enables end-to-end deterministic latency based on input timecode, genlock and PTP synchronization. Applicable for 29.97 fps video - `jamTime` (integer, required) — Daily jam time, in UTC hours. It shall be the same as the upstream timecode inserter. Range 0..23. - `utcTaiOffset` (integer, required) — Offset between TAI and UTC, in seconds. Default is 37 seconds. ### com.harmonicinc.vos.app.configure.model.service.St2110AudioLayout - `audioMapping` (list of integer, optional) — Audio mapping configuration for 2110 output streams ### com.harmonicinc.vos.app.configure.model.SrtCloudOutputSettings - `bandwidthOverhead` (integer, optional) — Bandwidth overhead - `blockingMode` (boolean, optional) — Blocking mode - `encryptionParam` (com.harmonicinc.vos.app.configure.model.SrtEncryptionParams, optional) - `latency` (integer, optional) — Latency - `srtConnectionSettingsList` (list of com.harmonicinc.vos.app.configure.model.SrtConnectionSettings, optional) — Srt connection settings list - `timeout` (integer, optional) — Timeout ### com.harmonicinc.vos.app.configure.model.SrtEncryptionParams - `encryptionKey` (string, optional) — Srt encryption key - `encryptionType` (enum, optional) — Srt encryption type - Allowed values: `AES_128`, `AES_192`, `AES_256`, `NO_ENCRYPTION` ### com.harmonicinc.vos.app.configure.model.source.ZixiEndPointSetting - `zixiEndpointId` (string, required) — Unique identifier of the zixi endpoint ### com.harmonicinc.vos.app.configure.model.destination.ZixiEncryptionParams - `encryptionKey` (string, optional) — Zixi encryption key - `encryptionType` (enum, optional) — Zixi encryption type - Allowed values: `ZIXI_AES_128`, `ZIXI_AES_192`, `ZIXI_AES_256`, `ZIXI_NO_ENCRYPTION` ### com.harmonicinc.vos.app.configure.model.destination.BackupSettings - `enable` (boolean, optional) — Enable backup publishing endpoint - `hostname` (string, optional) — IP address or hostname of backup origin server - `networkIpAddress` (string, optional) — Network Ip Address - `password` (string, optional) — Password of backup origin server - `path` (string, optional) — Path on the backup origin server to store the output files - `port` (integer, optional) — TCP port of backup origin server to connect to - `username` (string, optional) — Username of backup origin server ### com.harmonicinc.vos.app.configure.model.destination.DrmSettings - `enable` (boolean, optional) — Enable DRM on the publishing endpoint - `requestorId` (string, optional) — Requestor ID - `resourceId` (string, optional) — Resource ID - `url` (string, optional) — The URL to the DRM server ### com.harmonicinc.vos.app.configure.model.destination.ST2110_Output_St2110StreamComponent - `primaryMulticast` (com.harmonicinc.vos.app.configure.model.destination.ST2110_Output_MulticastConfig, optional) - `secondaryMulticast` (com.harmonicinc.vos.app.configure.model.destination.ST2110_Output_MulticastConfig, optional) - `streamType` (enum, optional) — ST2110 stream type - Allowed values: `ST2110_20`, `ST2110_30`, `ST2110_40` - `tid` (integer, optional) — Unique id for NMOS registration ### com.harmonicinc.vos.app.configure.model.service.CamAddon_CamParameters - `progNums` (list of integer, required) — List containing the Program Numbers to descramble with this CAM - `slotId` (integer, required) — CAM physical slot Id in DVB-CI card (Value 0 for CAM 1, 1 for CAM 2) ### com.harmonicinc.vos.app.configure.model.service.NielsenWatermarkProperties - `cbetCheckDigits` (string, optional) — CBET CheckDigits - `cbetSid` (integer, optional) — CBET Sid - `checkDigits` (string, optional) — Check Digits - `sid` (integer, optional) — Sid ### com.harmonicinc.vos.app.configure.model.service.ParentalControlAddon_Authentication - `enable` (boolean, optional) — The boolean to determine if enable authentication or not - `password` (string, optional) — The password of authentication settings - `username` (string, optional) — The username of authentication settings ### com.harmonicinc.vos.app.configure.model.service.ParentalControlAddon_TriggerRepublishOnEmptySchedule - `enable` (boolean, optional) — The boolean to determine if enable trigger republish on empty schedule - `intervalInMinutes` (integer, optional) — The interval in minutes to trigger republish on empty schedule ### com.harmonicinc.vos.app.configure.model.service.TimedEventAddon_Authentication - `enable` (boolean, optional) — The boolean to determine if enable authentication or not - `password` (string, optional) — The password of authentication settings - `username` (string, optional) — The username of authentication settings ### com.harmonicinc.vos.app.configure.model.service.TimedEventAddon_TriggerRepublishOnEmptySchedule - `enable` (boolean, optional) — The boolean to determine if enable trigger republish on empty schedule - `intervalInMinutes` (integer, optional) — The interval in minutes to trigger republish on empty schedule ### com.harmonicinc.vos.app.configure.model.SrtConnectionSettings - `ipAddress` (string, optional) — Ip address - `ipNetworkAddress` (string, optional) — Interface - `latency` (integer, optional) — Latency, specified for Srt - `port` (integer, optional) — Port - `srtEncryptionParams` (com.harmonicinc.vos.app.configure.model.SrtEncryptionParams, optional) - `streamId` (string, optional) — Stream id - `streamIndex` (integer, optional) — Stream Index ### com.harmonicinc.vos.app.configure.model.destination.ST2110_Output_MulticastConfig - `ipAddress` (string, optional) — IP address - `networkInterface` (string, optional) — The output network address - `port` (integer, optional) — IP port ## Examples ### Example 1 **Request** ```json {} ``` **Response** ```json { "destinations": [ { "destinationProfileId": "string", "id": "string", "inUse": true, "labels": [ "string" ], "modifiableByAffiliate": true, "name": "string", "outputs": [ { "id": "string", "outputType": "IP", "rank": 1, "redundancyMode": "MANDATORY", "asiSettings": { "port": 1, "card": "CARD_1", "muteAtStartup": true }, "hspSettings": { "hspEndpoint": "string", "variantPlaylistFileName": "string", "hspEndpointId": "string", "publicHspEndpoint": "string" }, "ipSettings": { "cloudOutputSettings": { "channelId": "string", "channelName": "string", "pipeId": "string", "pipeState": "OFFLINE", "protocol": "string", "region": "string", "regionDisplayName": "string", "srtCloudOutputSettings": { "bandwidthOverhead": 1, "blockingMode": true, "encryptionParam": { "encryptionKey": "string", "encryptionType": "AES_128" }, "latency": 1, "srtConnectionSettingsList": [ { "ipAddress": "string", "ipNetworkAddress": "string", "latency": 1, "port": 1, "srtEncryptionParams": { "encryptionKey": "string", "encryptionType": "AES_128" }, "streamId": "string", "streamIndex": 1 } ], "timeout": 1 }, "streamCount": 1 }, "cloudSourceOutputSettings": { "pipeId": "string", "protocol": "string", "region": "string", "regionDisplayName": "string" }, "cloudlinkGroupId": "string", "cloudlinkId": "string", "ipAddress": "string", "ipNetworkAddress": "string", "ipPort": 1, "labels": [ "string" ], "muteAtStartup": true, "poolBinding": { "complexityIp": "string", "complexityPort": 1, "divitrackCircuitId": 1, "divitrackMaxBitrate": 1, "divitrackMinBitrate": 1, "divitrackNominalBitrate": 1, "divitrackPriority": "VERY_HIGH", "divitrackStillImageBitrate": 1, "noDivitrack": true, "operationMode": "STATMUX_VBR", "poolId": "string", "stillImageDetectionMode": "DETECTION_OFF" }, "sourcePort": 1, "srtOutputSettings": { "bandwidthOverhead": 1, "blockingMode": true, "channelId": "string", "channelName": "string", "connectionMode": "LISTENER", "encryptionParam": { "encryptionKey": "string", "encryptionType": "AES_128" }, "endpointSettings": [ { "zixiEndpointId": "string" } ], "latency": 1, "streamId": "string", "timeout": 1 }, "zixiOutputSettings": { "channelId": "string", "channelName": "string", "encryptionParam": { "encryptionKey": "string", "encryptionType": "ZIXI_AES_128" }, "fecBlockMs": 1, "fecOverhead": 1, "latencyMode": "ZIXI_LATENCY_STATIC", "maxLatency": 1, "password": "string", "timeout": 1, "user": "string" } }, "originSettings": { "ipNetworkAddress": "string", "originOutputEndPoints": [ { "id": "string", "originOutputProtocol": "HTTP", "packagingProfileType": "string", "absoluteBaseURL": "string", "alternativeAbsoluteBaseURL": "string", "alternativePathwayName": "string", "backup": { "enable": true, "hostname": "string", "networkIpAddress": "string", "password": "string", "path": "string", "port": 1, "username": "string" }, "compatibilityMode": "STANDARD", "contentSteeringServerURL": "string", "drm": { "enable": true, "requestorId": "string", "resourceId": "string", "url": "string" }, "enableAbsoluteURL": true, "enableContentSteeringPlaylist": true, "fromliveAbsoluteBaseURL": "string", "headerAuthName": "string", "headerAuthValue": "string", "hostname": "string", "insertPlaylistCustomTag": true, "labels": [ "string" ], "localPathwayName": "string", "outputMode": "LIVE_AND_TIMESHIFT", "password": "string", "path": "string", "playlistCustomTag": "string", "port": 1, "profileName": "string", "publishName": "string", "redundancyMode": "NONE", "streamsPerTcpConnection": "ONE_STREAM", "username": "string", "variantPlaylistFileName": "string" } ] }, "psiSiTableSpoolingConfig": [ { "psiSiTables": [ { "bitrate": 1, "pid": 1, "psiSiContent": "string", "psiSiType": "PAT" } ] } ], "sdiSettings": { "card": 1, "gpio": { "enable": true, "enableRtn": true, "preroll": 1 }, "muteOutputOnSignalLoss": true, "port": 1, "sdiUhdSettings": { "sdiUhdType": "QUAD_3G", "sdiUhdVariant": "ST425_5_2SI" }, "st2110Parameters": { "nmosEnabled": true, "secondaryOutputEnabled": true, "st2110OutComponents": [ { "primaryMulticast": { "ipAddress": "string", "networkInterface": "string", "port": 1 }, "secondaryMulticast": { "ipAddress": "string", "networkInterface": "string", "port": 1 }, "streamType": "ST2110_20", "tid": 1 } ] } } } ], "type": "IP" } ], "pools": [ { "divitrackIP": "string", "divitrackIpNetworkAddress": "string", "divitrackPoolBitrate": 1, "divitrackPoolId": 1, "divitrackPoolLatencyMode": "DEFAULT", "divitrackPort": 1, "downstreamComplexityIpDelay": 1, "downstreamIpDelay": 1, "id": "string", "labels": [ "string" ], "maxSourcesDelay": 1, "muxAddress": [ "string" ], "name": "string", "poolMode": "VBR", "stcIp": "string", "stcPort": 1, "upstreamIpDelay": 1, "useNominalBitrate": true } ], "service": { "profileId": "string", "addons": { "affiliateAddon": { "affiliateId": "string" }, "broadcasterIdAddon": { "origin": "ATSC" }, "captionsAddon": { "captionsInfo": [ { "captionsProvider": "e_NCI", "tcpPort": 1 } ] }, "casAddon": { "casSystems": [ { "accessCriteria": "string", "casId": "string", "ecmId": "string" } ], "enable": true }, "demuxAddon": { "camAddon": { "camParameters": [ { "progNums": [ 1 ], "slotId": 1 } ] }, "demuxType": "e_DVB", "descramblingKeys": [ { "keyId": "string", "programNum": 1 } ], "descramblingPrograms": [ { "programNum": 1 } ], "highJitter": true }, "drmAddon": { "customKeyRotationTime": "2024-01-15T09:30:00Z", "enable": true, "settings": [ { "drmSystemId": "string", "originOutputEndPointId": "string", "resourceId": "string", "useFixedResource": true } ] }, "easPropertiesAddon": { "enableEas": true, "groupId": 1, "stationId": "string" }, "inputMonitoringAddon": { "enable": true }, "irdetoWatermarkAddon": { "directId": 1 }, "kantarSnapWatermarkAddon": { "audFileId": "string", "channelConfigs": [ { "channelName": "string", "languageIndex": 1, "sourceLabel": "string" } ], "licFileId": "string" }, "liveEventAddon": { "autoGenerateAcquisitionPointId": true, "confidenceMonitoring": true, "endTimeInUtc": "string", "recording": true, "startTimeInUtc": "string" }, "logoAddon": { "imageId": "string", "groupMode": true, "horizontalOffset": 1, "hourlySchedule": [ { "endMinute": 1, "endSecond": 1, "startMinute": 1, "startSecond": 1 } ], "logosList": [ { "imageId": "string", "horizontalOffset": 1, "placement": "BOTTOM_LEFT", "uuid": "string", "verticalOffset": 1 } ], "logosListForGroupMode": [ { "imageId": "string", "logoSlateGroupLabel": "string", "horizontalOffset": 1, "placement": "BOTTOM_LEFT", "verticalOffset": 1 } ], "placement": "BOTTOM_LEFT", "verticalOffset": 1 }, "muxAddon": { "bandwidth": 1 }, "nielsenWatermarkAddon": { "nielsenWatermarkConfig": [ { "languageIndex": 1, "nielsenWatermarkProperties": { "cbetCheckDigits": "string", "cbetSid": 1, "checkDigits": "string", "sid": 1 }, "sourceLabel": "string" } ] }, "operatorActionAddon": { "muteOperation": true }, "parentalControlAddon": { "callbackServer": { "authentication": { "enable": true, "password": "string", "username": "string" } }, "callbackUrl": "string", "channelId": "string", "commandScheduler": { "authentication": { "enable": true, "password": "string", "username": "string" }, "endpoint": "string", "triggerRepublishOnEmptySchedule": { "enable": true, "intervalInMinutes": 1 } }, "hlsID3Pid": 1 }, "playoutSettingsAddon": { "cleanLayers": [ { "layerId": 1 } ] }, "scheduler360Addon": { "channelId": "string" }, "scte35SlateAddon": { "enableVideoSlate": true, "graphicFilename": "string", "imageId": "string", "trigger": "e_AUTO", "zoneIdentity": "string" }, "slateWatermarkAddon": { "image_a_Id": "string", "image_b_Id": "string", "slateWatermarkType": "e_SLATE_IMAGE" }, "synamediaWatermarkAddon": { "channelId": "string", "watermarkType": "e_WATERMARKING" }, "thumbnailExporterAddon": { "generationInterval": 1, "exportPath": "string", "height": 1, "password": "string", "prefix": "string", "suffix": "e_TIMESTAMP", "userName": "string", "width": 1 }, "timeAdjustment": { "timeAdjInMs": 1 }, "timeAdjustmentAddon": { "timeAdjInMs": 1 }, "timedEventAddon": { "callbackServer": { "authentication": { "enable": true, "password": "string", "username": "string" } }, "callbackUrl": "string", "channelId": "string", "commandScheduler": { "authentication": { "enable": true, "password": "string", "username": "string" }, "endpoint": "string", "triggerRepublishOnEmptySchedule": { "enable": true, "intervalInMinutes": 1 } }, "hlsParentalControlID3Pid": 1, "hlsPeacockEventID3Pid": 1, "id3MetadataEventPid": 1, "timedEventType": "e_PARENTAL_CONTROL" }, "trafficAddon": { "trafficId": 1 }, "videoInsertionAddon": { "dpiTierSetting": { "authorizedDpiTiers": [ 1 ], "blockScte35InputMessages": true }, "esamServiceSetting": { "acquisitionPointId": "string", "passthroughOnInBandDisabled": true, "poisEndpoint": "string", "poisNotifyOnlyMode": true, "spliceImmediateSpeUtcPointOffset": 1, "timecodeReference": true, "tlsKeyId": "string", "utcTimeOffset": 1 }, "gpiTriggers": [ { "delay": 1, "edge": "GPI_RISING", "name": "string", "scte35Message": "string" } ] } }, "availabilityZone": "string", "controlState": "ACTIVATED", "deploymentInformation": { "accountPrefix": "string", "deploymentId": "string", "deploymentType": "string", "deviceName": "string", "platformRegionZone": "string" }, "destinationId": "string", "destinationsId": [ "string" ], "dynamicProgramMode": "ON", "extraVideoDelay": 1, "geoRedundancyMode": "ON", "geoRedundancyTimeReference": "AUTO", "id": "string", "labels": [ "string" ], "name": "string", "orchestrationLabels": [ { "key": "string", "value": "string" } ], "orchestrationNodeSelectors": [ { "key": "string", "value": "string" } ], "pauseGeoRedundancy": true, "priority": "LOW", "processingParameters": { "audioProperties": [ { "aacHeader": "e_ADTS", "ac4IframeInterval": 1, "bitrate": "e_AUTO_SELECT", "channels": "e_PASSTHROUGH", "gain": 1, "languageIndex": 1, "sampleRate": "e_16", "sourceLabel": "string", "targetlevel": "e_None" } ], "dataProperties": { "cc608To708Translation": "e_AUTOSENSE", "dvbSubBurnIn": { "enableDvbSubtitleBurnIn": true, "label": "string" }, "generateTimecode": "e_DISABLED", "teletextOverSdiOutput": "e_WST" }, "decoderSettings": { "contributionMode": true, "latency": { "e2eLatency": 1, "enableTcPtpLatency": true, "jamTime": 1, "utcTaiOffset": 1 }, "st2110AudioLayout": { "audioMapping": [ 1 ] } }, "streamConditioning": "AUTO", "videoProperties": { "aspectRatio": "e_16_9", "goplenM": "e_AUTO", "goplenN": 1, "gopoption": "e_OPEN_FIXED", "irisVQBoost": "e_DISABLED", "latencyOption": "e_2_5", "resolutionHV": "e_352x480I", "stressBias": "e_CLEAN" } }, "programNum": 1, "redundancyMode": "ON", "sdiAudioFormats": [ "PCM_stereo" ], "serviceSources": [ { "rank": 1, "sourceId": "string", "sourceSwitchBufferSize": 1 } ], "serviceTrackingMode": "ON", "serviceTrackingSetting": { "outputFollowInputPid": true, "pidOffset": 1 }, "serviceType": "LIVE", "sourceFailoverConditions": [ { "type": "PID_MISSING" } ], "sourceSwitchSetting": { "esamSourceSwitchSetting": { "fallbackTimeout": 1, "proprietaryScte104VitcMode": true }, "inactiveSourceHandling": "e_AUTO", "primaryStableTime": 1, "sourceSwitchTrigger": "e_SOURCE_FAILURE", "triggerSettings": { "ccErrorsThreshold": 1, "ccErrorsWindow": 1, "customPidMissingList": [ 1 ], "customPidMissingWindow": 1 } }, "subServices": [ { "profileId": "string", "addons": null, "destinationsId": [ "string" ], "dynamicProgramMode": "ON", "id": "string", "labels": [ "string" ], "programNum": 1 } ] } } ``` **SDK Code** ```python import requests url = "https://device.example.com/cluster1/vos-api/mux/v1/services" payload = {} headers = { "Authorization": "Bearer ", "Content-Type": "application/json" } response = requests.post(url, json=payload, headers=headers) print(response.json()) ``` ```javascript const url = 'https://device.example.com/cluster1/vos-api/mux/v1/services'; const options = { method: 'POST', headers: {Authorization: 'Bearer ', 'Content-Type': 'application/json'}, body: '{}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://device.example.com/cluster1/vos-api/mux/v1/services" payload := strings.NewReader("{}") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("Authorization", "Bearer ") req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://device.example.com/cluster1/vos-api/mux/v1/services") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Post.new(url) request["Authorization"] = 'Bearer ' request["Content-Type"] = 'application/json' request.body = "{}" response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.post("https://device.example.com/cluster1/vos-api/mux/v1/services") .header("Authorization", "Bearer ") .header("Content-Type", "application/json") .body("{}") .asString(); ``` ```php request('POST', 'https://device.example.com/cluster1/vos-api/mux/v1/services', [ 'body' => '{}', 'headers' => [ 'Authorization' => 'Bearer ', 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://device.example.com/cluster1/vos-api/mux/v1/services"); var request = new RestRequest(Method.POST); request.AddHeader("Authorization", "Bearer "); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = [ "Authorization": "Bearer ", "Content-Type": "application/json" ] let parameters = [] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://device.example.com/cluster1/vos-api/mux/v1/services")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "POST" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ``` ### Example 2 **Request** ```json {} ``` **Response** ```json { "destinations": [ { "destinationProfileId": "string", "id": "string", "inUse": true, "labels": [ "string" ], "modifiableByAffiliate": true, "name": "string", "outputs": [ { "id": "string", "outputType": "IP", "rank": 1, "redundancyMode": "MANDATORY", "asiSettings": { "port": 1, "card": "CARD_1", "muteAtStartup": true }, "hspSettings": { "hspEndpoint": "string", "variantPlaylistFileName": "string", "hspEndpointId": "string", "publicHspEndpoint": "string" }, "ipSettings": { "cloudOutputSettings": { "channelId": "string", "channelName": "string", "pipeId": "string", "pipeState": "OFFLINE", "protocol": "string", "region": "string", "regionDisplayName": "string", "srtCloudOutputSettings": { "bandwidthOverhead": 1, "blockingMode": true, "encryptionParam": { "encryptionKey": "string", "encryptionType": "AES_128" }, "latency": 1, "srtConnectionSettingsList": [ { "ipAddress": "string", "ipNetworkAddress": "string", "latency": 1, "port": 1, "srtEncryptionParams": { "encryptionKey": "string", "encryptionType": "AES_128" }, "streamId": "string", "streamIndex": 1 } ], "timeout": 1 }, "streamCount": 1 }, "cloudSourceOutputSettings": { "pipeId": "string", "protocol": "string", "region": "string", "regionDisplayName": "string" }, "cloudlinkGroupId": "string", "cloudlinkId": "string", "ipAddress": "string", "ipNetworkAddress": "string", "ipPort": 1, "labels": [ "string" ], "muteAtStartup": true, "poolBinding": { "complexityIp": "string", "complexityPort": 1, "divitrackCircuitId": 1, "divitrackMaxBitrate": 1, "divitrackMinBitrate": 1, "divitrackNominalBitrate": 1, "divitrackPriority": "VERY_HIGH", "divitrackStillImageBitrate": 1, "noDivitrack": true, "operationMode": "STATMUX_VBR", "poolId": "string", "stillImageDetectionMode": "DETECTION_OFF" }, "sourcePort": 1, "srtOutputSettings": { "bandwidthOverhead": 1, "blockingMode": true, "channelId": "string", "channelName": "string", "connectionMode": "LISTENER", "encryptionParam": { "encryptionKey": "string", "encryptionType": "AES_128" }, "endpointSettings": [ { "zixiEndpointId": "string" } ], "latency": 1, "streamId": "string", "timeout": 1 }, "zixiOutputSettings": { "channelId": "string", "channelName": "string", "encryptionParam": { "encryptionKey": "string", "encryptionType": "ZIXI_AES_128" }, "fecBlockMs": 1, "fecOverhead": 1, "latencyMode": "ZIXI_LATENCY_STATIC", "maxLatency": 1, "password": "string", "timeout": 1, "user": "string" } }, "originSettings": { "ipNetworkAddress": "string", "originOutputEndPoints": [ { "id": "string", "originOutputProtocol": "HTTP", "packagingProfileType": "string", "absoluteBaseURL": "string", "alternativeAbsoluteBaseURL": "string", "alternativePathwayName": "string", "backup": { "enable": true, "hostname": "string", "networkIpAddress": "string", "password": "string", "path": "string", "port": 1, "username": "string" }, "compatibilityMode": "STANDARD", "contentSteeringServerURL": "string", "drm": { "enable": true, "requestorId": "string", "resourceId": "string", "url": "string" }, "enableAbsoluteURL": true, "enableContentSteeringPlaylist": true, "fromliveAbsoluteBaseURL": "string", "headerAuthName": "string", "headerAuthValue": "string", "hostname": "string", "insertPlaylistCustomTag": true, "labels": [ "string" ], "localPathwayName": "string", "outputMode": "LIVE_AND_TIMESHIFT", "password": "string", "path": "string", "playlistCustomTag": "string", "port": 1, "profileName": "string", "publishName": "string", "redundancyMode": "NONE", "streamsPerTcpConnection": "ONE_STREAM", "username": "string", "variantPlaylistFileName": "string" } ] }, "psiSiTableSpoolingConfig": [ { "psiSiTables": [ { "bitrate": 1, "pid": 1, "psiSiContent": "string", "psiSiType": "PAT" } ] } ], "sdiSettings": { "card": 1, "gpio": { "enable": true, "enableRtn": true, "preroll": 1 }, "muteOutputOnSignalLoss": true, "port": 1, "sdiUhdSettings": { "sdiUhdType": "QUAD_3G", "sdiUhdVariant": "ST425_5_2SI" }, "st2110Parameters": { "nmosEnabled": true, "secondaryOutputEnabled": true, "st2110OutComponents": [ { "primaryMulticast": { "ipAddress": "string", "networkInterface": "string", "port": 1 }, "secondaryMulticast": { "ipAddress": "string", "networkInterface": "string", "port": 1 }, "streamType": "ST2110_20", "tid": 1 } ] } } } ], "type": "IP" } ], "pools": [ { "divitrackIP": "string", "divitrackIpNetworkAddress": "string", "divitrackPoolBitrate": 1, "divitrackPoolId": 1, "divitrackPoolLatencyMode": "DEFAULT", "divitrackPort": 1, "downstreamComplexityIpDelay": 1, "downstreamIpDelay": 1, "id": "string", "labels": [ "string" ], "maxSourcesDelay": 1, "muxAddress": [ "string" ], "name": "string", "poolMode": "VBR", "stcIp": "string", "stcPort": 1, "upstreamIpDelay": 1, "useNominalBitrate": true } ], "service": { "profileId": "string", "addons": { "affiliateAddon": { "affiliateId": "string" }, "broadcasterIdAddon": { "origin": "ATSC" }, "captionsAddon": { "captionsInfo": [ { "captionsProvider": "e_NCI", "tcpPort": 1 } ] }, "casAddon": { "casSystems": [ { "accessCriteria": "string", "casId": "string", "ecmId": "string" } ], "enable": true }, "demuxAddon": { "camAddon": { "camParameters": [ { "progNums": [ 1 ], "slotId": 1 } ] }, "demuxType": "e_DVB", "descramblingKeys": [ { "keyId": "string", "programNum": 1 } ], "descramblingPrograms": [ { "programNum": 1 } ], "highJitter": true }, "drmAddon": { "customKeyRotationTime": "2024-01-15T09:30:00Z", "enable": true, "settings": [ { "drmSystemId": "string", "originOutputEndPointId": "string", "resourceId": "string", "useFixedResource": true } ] }, "easPropertiesAddon": { "enableEas": true, "groupId": 1, "stationId": "string" }, "inputMonitoringAddon": { "enable": true }, "irdetoWatermarkAddon": { "directId": 1 }, "kantarSnapWatermarkAddon": { "audFileId": "string", "channelConfigs": [ { "channelName": "string", "languageIndex": 1, "sourceLabel": "string" } ], "licFileId": "string" }, "liveEventAddon": { "autoGenerateAcquisitionPointId": true, "confidenceMonitoring": true, "endTimeInUtc": "string", "recording": true, "startTimeInUtc": "string" }, "logoAddon": { "imageId": "string", "groupMode": true, "horizontalOffset": 1, "hourlySchedule": [ { "endMinute": 1, "endSecond": 1, "startMinute": 1, "startSecond": 1 } ], "logosList": [ { "imageId": "string", "horizontalOffset": 1, "placement": "BOTTOM_LEFT", "uuid": "string", "verticalOffset": 1 } ], "logosListForGroupMode": [ { "imageId": "string", "logoSlateGroupLabel": "string", "horizontalOffset": 1, "placement": "BOTTOM_LEFT", "verticalOffset": 1 } ], "placement": "BOTTOM_LEFT", "verticalOffset": 1 }, "muxAddon": { "bandwidth": 1 }, "nielsenWatermarkAddon": { "nielsenWatermarkConfig": [ { "languageIndex": 1, "nielsenWatermarkProperties": { "cbetCheckDigits": "string", "cbetSid": 1, "checkDigits": "string", "sid": 1 }, "sourceLabel": "string" } ] }, "operatorActionAddon": { "muteOperation": true }, "parentalControlAddon": { "callbackServer": { "authentication": { "enable": true, "password": "string", "username": "string" } }, "callbackUrl": "string", "channelId": "string", "commandScheduler": { "authentication": { "enable": true, "password": "string", "username": "string" }, "endpoint": "string", "triggerRepublishOnEmptySchedule": { "enable": true, "intervalInMinutes": 1 } }, "hlsID3Pid": 1 }, "playoutSettingsAddon": { "cleanLayers": [ { "layerId": 1 } ] }, "scheduler360Addon": { "channelId": "string" }, "scte35SlateAddon": { "enableVideoSlate": true, "graphicFilename": "string", "imageId": "string", "trigger": "e_AUTO", "zoneIdentity": "string" }, "slateWatermarkAddon": { "image_a_Id": "string", "image_b_Id": "string", "slateWatermarkType": "e_SLATE_IMAGE" }, "synamediaWatermarkAddon": { "channelId": "string", "watermarkType": "e_WATERMARKING" }, "thumbnailExporterAddon": { "generationInterval": 1, "exportPath": "string", "height": 1, "password": "string", "prefix": "string", "suffix": "e_TIMESTAMP", "userName": "string", "width": 1 }, "timeAdjustment": { "timeAdjInMs": 1 }, "timeAdjustmentAddon": { "timeAdjInMs": 1 }, "timedEventAddon": { "callbackServer": { "authentication": { "enable": true, "password": "string", "username": "string" } }, "callbackUrl": "string", "channelId": "string", "commandScheduler": { "authentication": { "enable": true, "password": "string", "username": "string" }, "endpoint": "string", "triggerRepublishOnEmptySchedule": { "enable": true, "intervalInMinutes": 1 } }, "hlsParentalControlID3Pid": 1, "hlsPeacockEventID3Pid": 1, "id3MetadataEventPid": 1, "timedEventType": "e_PARENTAL_CONTROL" }, "trafficAddon": { "trafficId": 1 }, "videoInsertionAddon": { "dpiTierSetting": { "authorizedDpiTiers": [ 1 ], "blockScte35InputMessages": true }, "esamServiceSetting": { "acquisitionPointId": "string", "passthroughOnInBandDisabled": true, "poisEndpoint": "string", "poisNotifyOnlyMode": true, "spliceImmediateSpeUtcPointOffset": 1, "timecodeReference": true, "tlsKeyId": "string", "utcTimeOffset": 1 }, "gpiTriggers": [ { "delay": 1, "edge": "GPI_RISING", "name": "string", "scte35Message": "string" } ] } }, "availabilityZone": "string", "controlState": "ACTIVATED", "deploymentInformation": { "accountPrefix": "string", "deploymentId": "string", "deploymentType": "string", "deviceName": "string", "platformRegionZone": "string" }, "destinationId": "string", "destinationsId": [ "string" ], "dynamicProgramMode": "ON", "extraVideoDelay": 1, "geoRedundancyMode": "ON", "geoRedundancyTimeReference": "AUTO", "id": "string", "labels": [ "string" ], "name": "string", "orchestrationLabels": [ { "key": "string", "value": "string" } ], "orchestrationNodeSelectors": [ { "key": "string", "value": "string" } ], "pauseGeoRedundancy": true, "priority": "LOW", "processingParameters": { "audioProperties": [ { "aacHeader": "e_ADTS", "ac4IframeInterval": 1, "bitrate": "e_AUTO_SELECT", "channels": "e_PASSTHROUGH", "gain": 1, "languageIndex": 1, "sampleRate": "e_16", "sourceLabel": "string", "targetlevel": "e_None" } ], "dataProperties": { "cc608To708Translation": "e_AUTOSENSE", "dvbSubBurnIn": { "enableDvbSubtitleBurnIn": true, "label": "string" }, "generateTimecode": "e_DISABLED", "teletextOverSdiOutput": "e_WST" }, "decoderSettings": { "contributionMode": true, "latency": { "e2eLatency": 1, "enableTcPtpLatency": true, "jamTime": 1, "utcTaiOffset": 1 }, "st2110AudioLayout": { "audioMapping": [ 1 ] } }, "streamConditioning": "AUTO", "videoProperties": { "aspectRatio": "e_16_9", "goplenM": "e_AUTO", "goplenN": 1, "gopoption": "e_OPEN_FIXED", "irisVQBoost": "e_DISABLED", "latencyOption": "e_2_5", "resolutionHV": "e_352x480I", "stressBias": "e_CLEAN" } }, "programNum": 1, "redundancyMode": "ON", "sdiAudioFormats": [ "PCM_stereo" ], "serviceSources": [ { "rank": 1, "sourceId": "string", "sourceSwitchBufferSize": 1 } ], "serviceTrackingMode": "ON", "serviceTrackingSetting": { "outputFollowInputPid": true, "pidOffset": 1 }, "serviceType": "LIVE", "sourceFailoverConditions": [ { "type": "PID_MISSING" } ], "sourceSwitchSetting": { "esamSourceSwitchSetting": { "fallbackTimeout": 1, "proprietaryScte104VitcMode": true }, "inactiveSourceHandling": "e_AUTO", "primaryStableTime": 1, "sourceSwitchTrigger": "e_SOURCE_FAILURE", "triggerSettings": { "ccErrorsThreshold": 1, "ccErrorsWindow": 1, "customPidMissingList": [ 1 ], "customPidMissingWindow": 1 } }, "subServices": [ { "profileId": "string", "addons": null, "destinationsId": [ "string" ], "dynamicProgramMode": "ON", "id": "string", "labels": [ "string" ], "programNum": 1 } ] } } ``` **SDK Code** ```python import requests url = "https://device.example.com/cluster1/vos-api/mux/v1/services" payload = {} headers = { "Authorization": "Bearer ", "Content-Type": "application/json" } response = requests.post(url, json=payload, headers=headers) print(response.json()) ``` ```javascript const url = 'https://device.example.com/cluster1/vos-api/mux/v1/services'; const options = { method: 'POST', headers: {Authorization: 'Bearer ', 'Content-Type': 'application/json'}, body: '{}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://device.example.com/cluster1/vos-api/mux/v1/services" payload := strings.NewReader("{}") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("Authorization", "Bearer ") req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://device.example.com/cluster1/vos-api/mux/v1/services") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Post.new(url) request["Authorization"] = 'Bearer ' request["Content-Type"] = 'application/json' request.body = "{}" response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.post("https://device.example.com/cluster1/vos-api/mux/v1/services") .header("Authorization", "Bearer ") .header("Content-Type", "application/json") .body("{}") .asString(); ``` ```php request('POST', 'https://device.example.com/cluster1/vos-api/mux/v1/services', [ 'body' => '{}', 'headers' => [ 'Authorization' => 'Bearer ', 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://device.example.com/cluster1/vos-api/mux/v1/services"); var request = new RestRequest(Method.POST); request.AddHeader("Authorization", "Bearer "); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = [ "Authorization": "Bearer ", "Content-Type": "application/json" ] let parameters = [] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://device.example.com/cluster1/vos-api/mux/v1/services")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "POST" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```