Discovery Player Properties

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

Property Description Required?
default_countdown

Specifies how long, in seconds, before the next video automatically starts.

Type: Integer

Example: See Setting the Default Countdown.

No
discovery_controls

Specifies Ooyala Discovery control settings.

Type: Container

No
discovery_enabled Enable or disable a specific discovery profile.

Type: Boolean

Valid Values: true | false

Example: See Enabling and Disabling Discovery Profiles for a Player.

No
discovery_interface

Specifies user interface settings.

Type: Container

No
exclude_content_types

Comma-separated list of content types that will be excluded from the Ooyala Discovery recommendations.

Type: List of Strings

Valid Values: video | live_stream

Default: none

Example: "live_stream","video"

No
exclude_labels

Comma-separated list of labels to exclude from Ooyala Discovery recommendations. To use this option, filter_by must be set to exclude_labels.

Type: List of Strings

Default: none

Example: "126ac19f053e424ab41bfbab5526ec30","d5751b77a0c24972888bf906734d8c34"

No
exclude_videos

Comma-separated list of video embed codes (or content IDs/asset IDs) to exclude from Ooyala Discovery recommendations.

Type: List of Strings

Default: none

Example: "126ac19f0fbab5526ec30","d5751b772888bf906734d8c34"

 
fallback_rules Reserved for future use No
filter_by

Specifies the type of label filtering to use. To exclude labels, specify exclude_labels and specify a list of labels in the exclude_labels parameter. To include specific labels, specify from_labels and specify a list of labels in the from_labels parameter. To only use labels shared by the source and recommended videos, specify shared_label.

Type: String

Default: none

Valid Values: exclude_labels | from_labels | shared_label

Example: "exclude_labels"

No
from_content_types

Comma-separated list of content types that will be included in the Ooyala Discovery recommendations. If no content types are supported and no types are excluded, any content type might be returned.

Type: List of Strings

Valid Values: video | live_stream

Default: none

Example: "video","live_stream"

No
from_labels

Comma-separated list of labels used for Ooyala Discovery recommendations. If no labels are specified, all labels are allowed.

Type: List of Strings

Default: none

Example: See Filtering with Labels.

No
hide_thumbnail_title

Hides the title of recommended video thumbnails.

Type: Boolean

Valid Values: true | false

Default: false

Example: See Hiding Thumbnails.
No
include_sub_account_assets

Specifies whether Ooyala Discovery recommendations include content from your sub-accounts.

Type: Boolean

Valid Values: true | false

Default: false

Example: "true"

No
optimization_goal Reserved for future use  
overrides

Specifies overrides to Ooyala Discovery that allow you to inject content into specific locations in the results. You specify the position of the override, the override type, and additional information.

If you want to inject promotional content, you can specify "label" and enter the ID of the promotional label.

If you want to pull information from each video's metadata, you specify "relation" and the metadata key to use. For example, you might want to choose the next video in a series. To do this, you might create a metadata entry called next_series_video and add this piece of metadata to each video in the series (specifying the content ID of the next video).

If you want to inject live content, specify "live" without any additional information.

Type: Container

Valid Values: label | relation | live

Default: none

Examples:

“1”: { “label”: “126ac19f053e424ab41bfbab5526ec30” }

“3”: { “relation”: “next_series_video” }

“5”: “live”

No
recency_threshold_in_days

Specifies the maximum age of content to display, in days. For example, you might want to create a player that only shows recommendations for content uploaded during the last week.

Type: Integer

Example: "7"

No
recommendation_scope

Specifies the scope of recommendations.

Type: Container

No
show_pause_screen

Enables the pause screen, which displays Ooyala Discovery recommendations whenever the user pauses the video.

Type: Boolean

Valid Values: true | false

Default: false

Example: See Turning on the Pause Screen.

No
when_done

Specifies what happens when the video ends. Options include displaying the Ooyala Discovery screen, showing the Up Next screen and automatically starting the next video, and none (using the default end screen settings).

Note: Up Next does not appear during ad playback.

Type: String

Valid Values: discovery_tray | up_next | none

Default: none

Example: "up_next"

No

Was this article helpful?