Edit

Use this endpoint to edit specific player under your site.

Endpoint
apiv2/players/edit/.json

This method is type of POST and will not receive any GET parameters.

Settings

Name Type Description
data[Player][id] *required integer Player id
data[Player][name] *required string Player name
data[Player][width] integer Set player width
data[Player][height] integer Set player height

Options

Name Type Description
data[Player][autoplay] bool Set player to autoplay
data[Player][autoplayInview] bool Set if you want your player to autoplay only when X % in view
data[Player][autoplayInviewPct] integer Set % for the autoplay in view option
data[Player][autoplay_desktop] bool Set player to autoplay on desktop only
data[Player][autoplay_on_ad] bool Set player to autoplay only if an ad exists
data[Player][force_muted] bool Force ads to play muted when the browser requires it
data[Player][pauseOffView] bool Pause video content when out of view
data[Player][pauseAdOffView] bool Pause ads when out of view
data[Player][start_volume] integer Set starting volume of player
data[Player][hover_volume] integer Set mouse rollover volume of player
data[Player][inpage_mobile_clicktoplay] bool Play in-page videos on iOS
data[Player][slide_inview] bool Set player to be sticky
data[Player][slide_inview_mobile] bool Disable sticky player on mobile
data[Player][slide_inview_pos] integer Set sticky player position: 0 - BR, 1 - BL, 2 - TL, 3 - TR
data[Player][inview_width] integer Set sticky player width in px
data[Player][inview_height] integer Set sticky player height in px
data[Player][slide_inview_show] string Show sticky close button on: "ad_start", "ad_end", "custom"
data[Player][mobile_width_inview] integer Set max mobile screen width in %

Special use

Name Type Description
data[Player][act_as_outstream] bool Set player to act as an outstream in-content unit
data[Player][act_as_outstream_inslide] bool Set player to act as an outstream in-slide unit

Playback

Name Type Description
data[Player][playlistPlayback] string Set how the player behaves on video end: "stop", "continuous"
data[Player][afterPlaylistEnd] string Set how the player behaves on playlist end: "stop", "loop"
data[Player][videoPlayback] string Set what the player shows on playlist end: "shareScreen", "relatedScreen", "startScreen"

Monetization

Name Type Description
data[Player][monetize] bool Set player to be monetizable
data[Player][adblocker_disables] bool Set player to disable if ad blocker is detected
data[Player][adblocker_disables_autoplay] bool Set player to disable autoplay if ad blocker is detected
data[Player][parser] string Set player ad parser used: "brid", "ima"
data[Player][adFrequency] integer Set ad frequency for the player
data[Player][adOffset] integer Set ad offset for the player
data[Player][autohide_ad_controls] bool Set player to autohide controls during ad display
data[Player][vpaid_controls] bool Show controls during VPAID ad display
data[Player][vpaid_advertisement] bool Show advertisement message during VPAID ad display
data[Player][block_3gp] bool Block 3GP ad creative renditions from displaying inside the player
data[Player][ad_preload] bool Enable ad pre-loading

Ad slots

Name Type Description
data[Player][ads][preroll][mobile][id][] integer Set a pre-roll in a mobile ad slot
data[Player][ads][preroll][desktop][id][] integer Set a pre-roll in a desktop ad slot
data[Player][ads][postroll][mobile][id][] integer Set a post-roll in a mobile ad slot
data[Player][ads][postroll][desktop][id][] integer Set a post-roll in a desktop ad slot
data[Player][ads][midroll][mobile][id][] integer Set a mid-roll in a mobile ad slot
data[Player][ads][midroll][desktop][id][] integer Set a mid-roll in a desktop ad slot
data[Player][ads][midroll][cuepoints] string Comma separated values in seconds for mid-roll display
data[Player][ads][midroll][adTimeType] string Set type of cue point: "s", "%"
data[Player][ads][banner][id][] integer Set a display banner ad
data[Player][ads][banner][overlayDuration] integer Set the display banner timeout

Buttons and skins

Name Type Description
data[Player][controls] bool Set the player to load its controls
data[Player][volume] bool Set the player to show its volume button
data[Player][fullscreen] bool Set the player to show its fullscreen button
data[Player][playlistScreen] bool Set the player to show its playlist button
data[Player][shareScreen] bool Set the player to show its share button
data[Player][titleBar] bool Set the player to show its video title display
data[Player][skin_id] integer Set a custom player skin
data[Player][playButtonColor] string Set a custom player colour
Example
<?php
require_once('lib/BridApi.php');
try {
    $api = new BridApi(array('auth_token'=>'b1437c94847d7e19268ad3bda0e46f8f6bc36f45'));
    $post = array('data[Player][id]'=>'123456', 'data[Player][name]'=>'Player name');
    $return = $api->post(['players', 'edit', 13085], $post);
    print_r($return);
} 
catch(Exception $e) {
    echo $e->getMessage();
}
?>

BridApi.php is a small library we provide in our git repository which allows you to quick-start your implementation so we advise you to use it. These examples are made with this library in mind. Make sure to substitute and use your own authorization token when trying out these examples.