Sign in
V2 > Player

Creates a new player.

post/1/vod/channel/{channel}/player

Path parameters

channelinteger required

The Channel unique identifier

Request body

defaultboolean
channel_idinteger

<br/>This field must exist on the channels database in the id column.

namestring required
descriptionstring
show_controlsboolean
show_progressionboolean
show_audioboolean
show_durationboolean
show_fullscreenboolean
show_default_logoboolean
show_speedboolean
default_speednumber

<br/>This field must be present and not empty if the show_speed field is equal to any of the following:1

is360boolean
encoding_change_enabledboolean
encoding_limitboolean
auto_startboolean
audio_volumenumber
show_replayboolean
show_loopboolean
show_relatedboolean
play_relatedboolean
related_typestring

<br/>This field must be present and not empty if the play_related field is equal to any of the following:1

widthnumber
heightnumber
controlbar_colorstring required
control_colorstring required
control_active_colorstring required
logo_imagestring
logo_image_mimetypestring

<br/>This field must be present and not empty only if any of the following fields are present:logo_image

logo_anchorstring

<br/>This field must be present and not empty if the logo_image field is equal to any of the following:1

logo_margin_verticalnumber

<br/>This field must be present and not empty if the logo_image field is equal to any of the following:1

logo_margin_horizontalnumber

<br/>This field must be present and not empty if the logo_image field is equal to any of the following:1

logo_percentagenumber

<br/>This field must be present and not empty if the logo_image field is equal to any of the following:1

show_media_infoboolean
show_media_thumbnailboolean
media_thumbnail_anchorstring

<br/>This field must be present and not empty if the show_media_thumbnail field is equal to any of the following:1

enable_facebookboolean
facebook_back_linkstring

<br/>This field must be present and not empty if the enable_facebook field is equal to any of the following:1<br/>This domain name must have a valid A or AAAA record.

facebook_player_embedboolean
enable_twitterboolean
twitter_viastring

<br/>This field must be present and not empty if the enable_twitter field is equal to any of the following:1

twitter_back_linkstring

<br/>This field must be present and not empty if the enable_twitter field is equal to any of the following:1<br/>This domain name must have a valid A or AAAA record.

twitter_relatedstring[]

<br/>This field must be present and not empty if the enable_twitter field is equal to any of the following:1

enable_embed_codeboolean
ads_enabledboolean
preload_imagestring
preload_image_mimetypestring
interrupt_imagestring
interrupt_image_mimetypestring

<br/>This field must be present and not empty only if any of the following fields are present:interrupt_image

geoip_imagestring
geoip_image_mimetypestring

<br/>This field must be present and not empty only if any of the following fields are present:geoip_image

restrict_imagestring
restrict_image_mimetypestring

<br/>This field must be present and not empty only if any of the following fields are present:restrict_image

force_media_ratioboolean

Response

Created

result'success' | 'error' | 'asynchronous' required

Result of the HTTP request

Example response

{
  "result": "success"
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.