/sapi/playout is the endpoint for managing Playouts (player configurations). A Playout is stored as an object with a list of player configuration properties.

1.0 | Object structure

The below structure is a JSON representation of a Playout object. All Playout properties are stored as strings.

JSON Playout object
id: "1096",
main: "false",
publicationid: "1",
type: "Playout",
name: "autoplay test",
status: "active",
createddate: "2018-07-30T07:27:50Z",
updateddate: "2018-07-30T07:27:50Z",
updatedBy: "support@bluebillywig.com",
label: "autoplay_test",
publication: “ovp",
id: "189",
name: "Blue Billywig Standard",
type: "swf",
src: "",
html5src: "/apps/player/html5/player/",
updateddate: "2018-08-08T14:53:37Z"
responsiveSizing: "true",
width: "100%",
height: "1",
autoHeight: "false",
alphaControlBar: "60",
skin_backgroundColor: "ffffff",
skin_foregroundColor: "6699cc",
skin_widgetColor: "6caedf",
bgColor: "ffffff",
logoId: "",
logoAlign: "TOPRIGHT",
logoClickUrl: "",
controlBar: "Autohide",
controlBarPlacement: "Auto",
timeDisplay: "Hide",
timeLine: "Show",
muteButton: "Show",
volume: "Show",
volumeOrientation: "vertical",
languageSelect: "Hide",
qualitySelector: "Show",
fullScreen: "Show",
shareButton: "Show",
shareButtonEmbedCode: "true",
shareButtonEmail: "false",
shareButtonFacebook: "true",
shareButtonGooglePlus: "true",
shareButtonLinkedIn: "true",
shareButtonPinterest: "false",
shareButtonTwitter: "true",
shareButtonWhatsApp: "true",
showBigPlayButton: "true",
title: "Show",
date: "Hide",
authorCopyright: "Hide",
authorCopyrightAlign: "TOPRIGHT",
authorCopyrightPrefixText: "source:",
autoPlayNext: "false",
relatedItems: "Show",
useDeeplinkForRelatedItems: "false",
exitscreenItemsListId: "",
randomizeRelatedItems: "false",
useDeeplinkForFacebook: "false",
shareTwitterText: "Currently watching:",
sharePlayout: "",
skinBehaviour: "Auto",
skinOnTimeline: "false",
nativeControls: "true",
youTubeHosting: "false",
forceNativeFullscreen: "false",
preferHD: "false",
nedStatLoggerUrl: "",
googleAnalyticsId: "",
piwikUrl: "",
piwikSiteId: "",
adobeAnalytics_trackingServer: "",
adobeAnalytics_mcorgId: "",
adobeAnalytics_rsId: "",
adobeAnalytics_legacy: "false",
disableCookies: "false",
disableContextMenuNavigate: "false",
playerSignature: "",
playerSignatureLink: "",
autoPlay: "true",
autoMute: "false",
autoMuteIfNeededForAutoPlay: "false",
autoLoop: "false",
float_player: "false",
interactivity_inView: "none",
interactivity_outView: "none",
inviewMargin: "50%",
textAbovePlayer: "",
textCommercialSkip: "",
startCollapsed: "false",
playInOverlay: "false",
hidePlayerOnEnd: "false",
waitForApproval: "false",
interactivity_mouseIn: "none",
interactivity_mouseOut: "none",
interactivity_onClick: "none",
clickUrl: "",
nsiNoAutoPlay: "false",
nsiNoPlayer: "false",
placementOption: "default",
placementDOMSelector: "",
iframeBreakout: "false",
clearBothOption: "never",
forceInview: "false",
customCode: "",
preferFlashPlayback: "false",
preloadMainroll: "false",
enableHtml5VPAID: "true",
commercialPauseButton: "false",
commercialMuteButton: "false",
commercials: "true",
textCommercialTimeRemaining: "Commercial time remaining:",
commercialBehaviour: "Once per load",
minClipDurationPreroll: "",
minClipDurationPostroll: "",
allowBBIma: "false",
fitmode: "FIT_SMART",
viewpage_overrideDimensions: "true",
viewpage_hideTitles: "false",
viewpage_alignment: "center",
viewpage_backgroundColor: "ffffff",
viewpage_color: "ffffff",
viewpage_backgroundClipId: "",
viewpage_backgroundPosition: "top left",
viewpage_backgroundSize: "cover",
viewpage_backgroundRepeat: "no-repeat",
viewpage_logo1ClipId: "",
viewpage_logo1Position: "top left",
viewpage_logo2ClipId: "",
viewpage_logo2Position: "top right",
viewpage_logo3ClipId: "",
viewpage_logo3Position: "bottom left",
viewpage_logo4ClipId: "",
viewpage_logo4Position: "bottom right",
noStats: "false",
forceIOSNativeVideo: "false",
aspectRatio: "",
adunits: null,
hasAdunits: false,
audioTrackSelect: "show",
shareText: "Currently watching:",
shareButtonDirectLink: "false",
googleAnalytics_customVars: "",
defaultSubtitle: "first",
defaultAudioTrack: "first",
forceCanAutoPlay: "false",
stickyMode: "",
disableKeyboardControls: "false",
taggingDisabled: "false"

2.0 | Create/Update

PUT /sapi/playout

The payload should be a JSON encoded Playout object. The only mandatory field is label. Label is also required to be unique as it is used to refer to the Playout in an embed code URL. Settings that are not specified when PUTting a Playout object will be derived from the default player settings. The returned Playout object will always be completely populated.

The player section should be left default. The default (Blue Billywig standard) is maintained by us and will receive automatic service updates at least every 2 weeks. Most other properties can be customized. For a functional description of configurable Playout properties we recommend the Playout section of the Online Video Platform user interface.

3.0 | Retrieve

GET /sapi/playout

Retrieves a list of Playouts. By default a list of the 15 most recently created Playouts will be returned.

3.1 | Params

q(string) specify a query to select a subset?q=title:”my fantastic new Playout”
sort(string fieldname string direction) determine sorting field and direction (default is id desc)?sort=title asc
limit(integer) determine the number of Playouts to return?limit=100
offset(integer) determine an offset to start the list?offset=100

3.2 | Result

An items container containing the requested Playout objects.

GET /sapi/playout/ID

Retrieves a complete Playout object containing all references and metadata properties.

4.0 | Delete

DELETE /sapi/playout/ID

Causes a Playout to be permanently deleted.

Updated on July 8, 2020

Was this article helpful?

Related Articles