Managing Player V3 Third-Party Modules Using the Backlot REST API (Deprecated)

With third-party modules, you can associate additional features with V3 players.

Note: For more information about REST API commands for the Ooyala player, see the Backlot API Reference.
Note: Ooyala Player V3 has been deprecated and is scheduled to be disabled. For details and alternatives, see the OVP Release Notes.
The following third-party modules are currently available for Player V3:
  • Playlists/Pods, module ID d42a1c8d4f91437c88db1c25cb8d6d04
To see descriptions of all available third-party modules, use the [GET] /v2/third_party_modules request.

List Available Third-Party Modules

[GET]/v2/third_party_modules

The system responds with an items hash describing all available third-party modules. For example:

{  
   "items":[  
      {  
         "description":"Playlists",
         "is_flash":"false",
         "is_v3":"true",
         "id":"d42a1c8d4f91437c88db1c25cb8d6d04",
         "type":"v3-playlists"
      }
   ]
}

Associate Third-Party Module with a Player

When you associate a third-party module with a player, you can optionally include properties that set certain characteristics.

[PUT] /v2/players/player_id/third_party_modules/third_party_module_id{  
   {  
      "parameters":{  
         properties
      }
   }
}

View Third-Party Modules Associated with a Player

To view all third-party modules associated with a player:

[GET]/v2/players/player_id/third_party_modules

To view details about a single third-party module associated with a player:

[GET]/v2/players/player_id/third_party_modules/third_party_module_id

Update Third-Party Module Information

New properties are added, and existing properties are updated. Parameters not included in the parameters hash are not affected or deleted.
Note: If you need to delete a parameter (rather than simply update its value), you can first DELETE the original association and then recreate it with the original PUT request but excluding the undesired parameter.
[PATCH]/v2/players/player_id/third_party_modules/third_party_module_id{  
   {  
      "parameters":{  
         properties
      }
   }
}

Delete Association of Third-Party Module with a Player

[DELETE]/v2/players/player_id/third_party_modules/third_party_module_id

Route Attributes

The following table describes all attributes that can be expressed through the route.

Route Attribute Description
player_id

The ID of the player.

Type: String

Default: None

Example: b4f1a93b779145b4a9c8ef15f8502345

third_party_module_id

The ID of the third-party module.

Type: String

Default: None

Example: d42a1c8d4f91437c88db1c25cb8d6d04

Properties

The following table describes all properties that can be associated with a player.

Property Description Third-Party Module
activeMenuColor Background color of selected tab in pod

Type: Hexadecimal color value

Default: #ffbb00

Example: "#ffbb00"

Playlists/Pods
caption

Format of title, description, and duration displayed in a pod.

Values can be combined in any order, with a dash as delimiter, like the following examples:
  • "title" - to display only title
  • "title-description" - to display title and description
  • "title-description-duration" - to display all info
  • "title-duration" - to display title and duration only

Type: String

Valid Values: title | description | duration

Default: title

Example: "title-description-duration"

Playlists/Pods
captionPosition

Position of caption relative to thumbnails

Type: String

Valid Values: inside | outside

Default: inside

Example: "outside"

Playlists/Pods
parameters Parent element for all properties for a specific third-party module  
podType

Format of pod.

Type: Boolean

Valid Values: scrolling | paging

Default: scrolling

Example: "scrolling"

Playlists/Pods
position

Position of PODs relative to a player,.

Note that in playerless PODs, in which we have no player, top and bottom are rendered the same way, as are "right" and "left".

Type: String

Valid Values: top | bottom | left | right | none  

Default: bottom

Example: "top"

Playlists/Pods
rowsNumber Set number of rows, only when podType is “paging”. Value is not limited.

Type: Integer

Default: 1

Example: "10"

Playlists/Pods
theme

Color scheme of pod

Type: String

Valid Values: dark | light

Default: dark

Example: "light"

Playlists/Pods
thumbnailsSize

Width of thumbnails in pixels; heigth is calculated from this.

Type: Integer

Default: 150

Example: "175"

Playlists/Pods
thumbnailsSpacing

Spacing between thumbnails in pixels

Type: Integer

Default: 3px

Example: "4px"

Playlists/Pods
wrapperFontSize

Baseline font size in pixels. All other text sizing is relative to this.

Type: Integer

Default: 14px

Example: 12px

Playlists/Pods

Examples

This example displays information about all available third-party modules:

[GET]/v2/third_party_modules

Backlot returns a response similar to the following:

{  
   "items":[  
      {  
         "description":"Playlists",
         "is_flash":"false",
         "is_v3":"true",
         "id":"d42a1c8d4f91437c88db1c25cb8d6d04",
         "type":"v3-playlists"
      }
   ]
}
Note:

Try out the code samples using your account credentials in the Ooyala Scratchpad. For information about using the Scratchpad, see Practice Making Requests with the Scratchpad. To launch the scratchpad, go to Ooyala API Scratchpad.

This example associates the Playlists/Pods third-party module (identified by d42a1c8d4f91437c88db1c25cb8d6d04) with a player:

[PUT]/v2/players/e18ab1da1813483499554ea2d8e67fbd/third_party_modules/d42a1c8d4f91437c88db1c25cb8d6d04{  
   "parameters":{  
      "menuFontSize":"10",
      "thumbnailsSpacing":"0",
      "thumbnailsSize":"150",
      "activeMenuColor":"#f50505",
      "caption":"",
      "wrapperFontSize":"",
      "podType":"scrolling",
      "tabsFontSize":"",
      "position":"bottom",
      "captionPosition":"inside",
      "theme":"dark"
   }
}

Backlot returns a response similar to the following:

{  
   "description":"Playlists",
   "is_flash":"false",
   "parameters":{  
      "menuFontSize":"10",
      "thumbnailsSize":"150",
      "position":"bottom",
      "podType":"scrolling",
      "activeMenuColor":"#f50505",
      "tabsFontSize":"",
      "caption":"",
      "wrapperFontSize":"",
      "captionPosition":"inside",
      "thumbnailsSpacing":"0",
      "theme":"dark"
   },
   "is_v3":"true",
   "id":"d42a1c8d4f91437c88db1c25cb8d6d04",
   "type":"v3-playlists"
}
Note:

Try out the code samples using your account credentials in the Ooyala Scratchpad. For information about using the Scratchpad, see Practice Making Requests with the Scratchpad. To launch the scratchpad, go to Ooyala API Scratchpad.

This example lists all third-party modules associated with player e18ab1da1813483499554ea2d8e67fbd:

[GET]/v2/players/e18ab1da1813483499554ea2d8e67fbd/third_party_modules

Backlot returns a response similar to the following:

{  
   "items":[  
      {  
         "parameters":{  
            "activeMenuColor":"#f50505",
            "position":"bottom",
            "caption":"",
            "podType":"scrolling",
            "menuFontSize":"10",
            "thumbnailsSize":"150",
            "wrapperFontSize":"",
            "thumbnailsSpacing":"0",
            "tabsFontSize":"",
            "theme":"dark",
            "captionPosition":"inside"
         },
         "type":"v3-playlists",
         "id":"d42a1c8d4f91437c88db1c25cb8d6d04",
         "is_flash":"false",
         "description":"Playlists",
         "is_v3":"true"
      }
   ]
}
Note:

Try out the code samples using your account credentials in the Ooyala Scratchpad. For information about using the Scratchpad, see Practice Making Requests with the Scratchpad. To launch the scratchpad, go to Ooyala API Scratchpad.

해당 내용이 도움 되었습니까?