Player API

player proporciona los siguientes métodos API para permitir que un diseño interactúe con el reproductor en el que se muestra. Todos los métodos deben invocarse en el objeto playerApi.

.previous() – Navega al elemento anterior en el playlist actual.

.next() – Navega al elemento siguiente en el playlist actual.

.pause() – Pausa el reproductor (playlist) actual.

.resume() – Reanuda la reproducción de la presentación (playlist) si se ha pausado.

.resumeNext() – Reanuda la reproducción de la presentación (playlist) si se ha pausado y reproduce inmediatamente la diapositiva siguiente.

.getHeaders() o .headers() – Devuelve los encabezados necesarios para la autenticación al realizar llamadas a servicios web.

.webService() – Devuelve la dirección base de los servicios web.

.loginDetails() – Devuelve información sobre el inicio de sesión del player. Están disponibles los siguientes campos:

• accessToken

• id

• name

• type

• webService.onMessage

.onMessage(string, callback) – Se utiliza para suscribirse a los mensajes enviados al reproductor (player) a través de la red. Para enviar un mensaje, se accede al reproductor mediante http://[player]:65001/player/[string]. La función de devolución de llamada (callback) recibe un parámetro con cualquier variable GET pasada junto con la URL. Véase más abajo un ejemplo.

.playerMetaData() – Devuelve un objeto con diversos metadatos del reproductor (player). Están disponibles los siguientes campos (nota: hay 20 campos de metadatos personalizados adicionales que el cliente puede definir y utilizar)

1. player_name

2. calle

3. city

4. state

5. country

6. planta

7. habitación

8. notas

9. código postal

10. latitud

11. longitud

12. orientación

13. Campos de metadatos personalizados 1-20

Player Ejemplo de API

Mostrar diferentes elementos en función del código postal de un eplayer.

var zip = playerApi.playerMetaData().zip;

if(zip.indexOf(‘75075’) > -1){

$(‘#element_0_0’).hide();

$(‘#element_0_1’).show();

}

Modificar el contenido en función de un mensaje HTTP enviado a través de la red

//suponiendo una solicitud a http://myplayer:65001/player/message?title=Hello&body=I, veo que estás mirando mi señalización.

playerApi.onMessage(‘message’, function(args){

$(‘#0_0’).text(args.title);

$(‘#0_1’).text(args.body);

});

Media Player Llamadas a la API a través de la API de Korbyt Services

Player

GET

Obtener detalles del jugador o enumerar players

POST

Crear/actualizar un archivo multimedia y reproducirlo en un reproductor (player)

PUT

Reproducir un archivo multimedia existente en player

DELETE

Eliminar una solicitud de envío o reproducción existente

PUT

Activar una acción de «player»

Player Group

GET

Obtener detalles del reproductor de player group o enumerar grupos

POST

Crear/actualizar un archivo multimedia y reproducirlo en un player group

PUT

Reproducir un archivo multimedia existente en player group

DELETE

Eliminar una solicitud de envío o reproducción existente (grupo)

PUT

Activar una acción de players por grupo

Playlist

GET

Obtener detalles de la lista de reproducción o enumerar unplaylists

PUT

Actualizar «playlist» dinámico: establecer etiquetas y forzar registros de reproductores asociados

POST

Crear un nuevo «playlist» inteligente con contenido estático

POST

Actualizar «playlist» estáticos o inteligentes y forzar los registros de los jugadores asociados

Scriptlets

GET

Obtener detalles de scriptlets o enumerar scriptlets

PUT

Instalar scriptlet

DELETE

Desinstalar scriptlet