Documentation sur l'audio-vidéo

accessToken

string

null

DEV | PROD

Token d'identification de l'utilisateur pour permettre la lecture des médias premium. 

activateComscoreV2

true | false

false 

DEV | PROD

Active la métrie comscore v2.

adUrl

string <url>

null

DEV 

Force une URL où récupérer un VAST de publicité.

audioApi

true | false 

null

DEV | PROD

Mets le lecteur en mode audio API. Ce qui "render" seulement un tag audio sans aucun visuel. 

autoplay

true | false

false

DEV | PROD

Permets la lecture automatique du média

brandColor

string ex: "#00A5AD"

null

DEV | PROD

Permets d'assigner la couleur de marque au différents éléments du lecteur.

canReduce

true | false

false

DEV | PROD

Affiche le bouton reduce, qui permet de mettre le lecteur en mode réduit.

clientId

string ex: "radiocanadaca_unit"

null

DEV | PROD

Permet de récupérer les paramètres selon le clientId dans bambou.

disableInfoPanel

true | false

false

DEV | PROD

Cache le panneau d'information comprenant le titre, le nom de l'émission, le bouton retour et le bouton X.

disableInfoPanelButton

true | false

true

DEV | PROD

Cache la flèche en haut à gauche indiquant à l'intégration que l'utilisateur souhaite quitter le player

disableTracking

true | false

false

DEV | PROD

Désactive la metrie pour le lecteur audio/vidéo.

reduceOnInit

true | false

false 

DEV | PROD

Initialise le player en mode reduit.

removeUnreduce

true | false 

false

DEV | PROD

Retire le bouton unreduce du lecteur lorsqu'elle est en mode reduce.

dai

true | false

false 

DEV | PROD

Active les publicités DAI si disponibles.

disableShortcuts

true | false

false

DEV | PROD

Permets de désactiver les raccourcis claviers pour une instance du lecteur.

disableTimeControl

true | false

null

DEV | PROD

Contrôle l'affichage de l'heure dans la barre de contrôles pour les diffusions en direct.

servicesEnv

string ex:"dev"

null

DEV | PROD

Permets de spécifier un environement pour metaMedia et validationMedia à des fins de tests seulement. Il bypass les paramètres spécifiés dans le build du player.

heartbeat

true | false

false

DEV

Active la métrie Adobe HeartBeat

heartbeatDebug

true | false

false

DEV

Permet de mettre heartbeat en mode debug. Ce qui affiche plusieurs messages dans la console. 

mediaAnalyticsEnable

true | false 

false 

DEV

Active la métrie de média analytics.

noAds

true | false

false

DEV

Désactive les publicités sur cette instance du lecteur.

pageShare

string

null

DEV | PROD

URL vers la page web référente du partage. Si non défini, le bouton de partage ne s'affichera pas.
L'URL comprend les paramètres pouvant être utilisés dans la construction de l'URL sous forme: <%=PARAM%>

Par exemple, http://ici.radio-canada.ca aura comme pageShare:
http://ici.radio-canada.ca/info/videos/media-<%=idMedia%>/<%=urlDesc%>?isAutoPlay=true

Liste des paramètres:

• appCode: Code d'application du média (medianet, medianetlive, toutv)

• idMedia: Code numérique du média

• title: Titre du média provenant des métas

• urlDesc: Dernière partie de l'URL de la page en cours de consultation après le dernier "/" et avant le "?"

providerId

string <azure | hls | html>

html

DEV | PROD

Si présent, force le type de provider qui sera utilisé pour la lecture du média.

width

string

null

DEV | PROD

Force la largeur du lecteur.

exitFullscreenOnEnd

true | false

true

DEV | PROD

Permet de choisir le comportement de player à la fin de lecture en mode fullscreen. Si le paramètre est à false, le player reste en mode fullscreen, auterment  le player revient en mode embed.

useExternalFont

true | false

false

DEV | PROD

Permet redéfinir le font de player par défault. 

canCast

true | false

true

DEV | PROD

Active ChromeCast a true, le désactive a false. 
A true, le bouton apparait seulement sur Chrome. 

 isModeResume

true | false

false

DEV | PROD

Permet d'utiliser le mode résume.

time

int

0

DEV | PROD

Commence la lecture à une possition time (en seconde)

multiInstance

true | false

false 

DEV | PROD

Si true, les multiples players sur la page peuvent  jouer en même temps 

meta

object

null

DEV | PROD

Permet de définir certaines valeurs des métadonnées.

Liste des valeurs permises:

• Program: Nom de l'émission / chaîne / film

• Title: Titre de l'émission / Saison et épisode

• teaserUrl: Url d'une image à utiliser pour le teaser ou un élément "picture" passé en chaîne de caractères ("<picure ..."). 

Exemple

format9x16

true | false

false

DEV | PROD

Afficher le player en mode 9x16 et permettre une meilleure lecture des vidéos verticales

hideUI

true | false

false

DEV | PROD

Masquer l’interface utilisateur du player, à l’exception du bouton play pour démarrer une vidéo

loop

true | false

false

DEV | PROD

Lire le média en boucle

translocate(<location>, <allowDuringAd = false>)

location (required) <string>: ID de l'élément du DOM vers lequel le lecteur sera déplacé. 

allowDuringAd (optinal) <boolean>: Permettre le déplacement durant les publicités.

Déplace le lecteur vers un autre conteneur. Il est important d'utiliser cette méthode puisqu’on doit réinitialiser certaines librairies.

play()

NA

Démarre la lecture du média.

pause()

NA

Pause la lecture du média.

setReduceMode(<reduced>)

reduced (required) <boolean>: État "reduced" du lecteur.

Informe le lecteur qu'il est en mode réduit ou non.

dispose()

NA

Détruis l'instance actuelle du lecteur.

changeMedia(<idMedia>, <appCode>, <params>)

idMedia (required) <string>: ID du média à charger

appCode (required) <string>: appCode du média à charger

params (optinal) <object>: nouveaux paramètres d'intégrations

Change le média en cours.

getPlayerLog(<exportType>)

exportType <string>: Type de retour voulu. Options possibles: DATA, CONSOLE, FILE

Permets de récupérer les logs du lecteur. 

setAccessTokenApi(<accessToken>)

accessToken <string>: Jeton d'accès provenant de la page. 

Permets d'aller récupérer les "claims" pour la lecture de contenus protégés.

volume(<level>)

level <int>: Valeur de volume en pourcentage

Permets d'ajuster le volume sans utiliser le UI.

mute()

NA

Mute le son du lecteur

unMute()

NA

Unmute le son du lecteur.

seekTo(<time>)

time <int>: Temps en seconde en rapport avec la durée du média.

Déplace la lecture au temps donné

seekForward(<time>)

time <int>: Nombre de secondes à avancer.

Avance la lecture d'un certain nombre de secondes.

seekBack(<time>)

time <int>: Nombre de secondes à reculer.

Recule la lecture d'un certain nombre de secondes.

setCastMediaInfo(mediaInfo)

Array<chrome.cast.media.MediaInfo>: array de media 

Set MediaInfo pour Cast avec enchaînement. 

fullscreen()

NA 

Active ou désactive le mode plein écran.

focusOnPlay()

removeA11yFocus(Optinal) <bool>: Flag pour conserver le focus a11y Default false

Met le focus sur le bouton play/pause dans le bas du lecteur

names

NA

Retourne la liste de noms des événements disponibles au lecteur. Voir la liste complète au bas de la page.

emit(<eventName>)

eventName: Nom de l'événement disponible dans la variable "names" mentionné plus haut. 

Permet de lancer un évément javascript. 

on(<eventName>, <callback>)

eventName: Nom de l'événement disponible dans la variable "names" mentionné plus haut. 

callback: Fonction gérant le retour de l'événement. Des paramètres sont disponibles selon les événements.

Ajoute une écoute d'événement JavaScript (addEventListner)  

off(<eventName>)

eventName: Nom de l'événement disponible dans la variable "names" mentionné plus haut. 

Retire l'écoute d'événement JavaScript (removeEventListner)  

AD_BREAK_COMPLETE

Fin d'une pause publicitaire (mid-roll).

AD_BREAK_START

Début d'une pause publicitaire (mid-roll).

AD_COMPLETE

Fin des publicités qui précède un média (pre-roll).

AD_ERROR

Erreur durant les publicités.

AD_PAUSE

La lecture des publicités est en pause.

AD_STARTED

Début des publicités.

ALL_ADS_COMPLETE

Toutes les publicités sont complétées pour le média actuel.

BEGIN

Lancé dès que le média est demandé à jouer. 

BITRATE_CHANGED

Changement de résolution complété.

CAST_REQUESTED

Indique que l'utilisateur demande de faire CAST

CLOSING_CREDITS

Début du générique de fin de média.

CONTENT_END

Fin du média en cours.

DAI_COMPANIONS

Indique des des companions DAI sont disponibles sur la publicité DAI actuelle.

Arguments:

1. companions - Liste des companions disponibles pour la publicité en cours. Vide si aucun companion n'est disponible pour la publicité.

companions

DISABLE_SHORTCUTS

Désactivation des raccourcis claviers.

DISPOSE

Destruction de l'instance du lecteur.

ENABLE_SHORTCUTS

Activation des raccourcis claviers.

END

Média et postroll sont terminés.

ENTER_FULL_SCREEN

Activation du mode plein écran.

ERROR

Erreur survenue durant la lecture.

EXIT_FULL_SCREEN

Sortie du mode plein écran.

LOAD_START

Début du chargement du média.

MEDIA_CHANGED

Changement de média terminé.

META_CHANGED

Changement des metas data terminé.

MUTE

Le volume du lecteur est passé en sourdine (muted)

PAUSE

Le média est en pause.

PLAY

Lecture du média.

PLAYING

Le média est présentement en lecture.

PLAYING_OUTSIDE

Une autre instance de lecture démarre la lecture d'un média.

READY

Le lecteur est prêt à jouer le média

REDUCE

Sélection du mode réduit.

SEEK_END

Fin du "seek" media.

SEEK_START

Début du "seek" média.

START

Début de la lecture initiale d'un média.

TIME_UPDATE

Temps courant du média.

Arguments:

1. "timeState" (État du temps du média)

TimeState (État du temps du média)

UNMUTE

Le volume du lecteur est passé à normal (unmuted)

VOLUME_CHANGE

Changement au volume de lecture.

WAITING

Le lecteur est en attente de chargement.

WARNING

Erreur non fatal.