CAYIN SDK v1.0

CAYIN SDK v1.0

El sistema de CAYIN Señalización Digital proporciona un potente SDK (kit de desarrollo de software), permitiendo crear su propia herramienta de administración mediante APIs basados en HTTP. Aquí hay cuatro principales secciones:

Habilitar/Inhabilitar CAYIN SDK

Habilitar/Inhabilitar CAYIN SDK

Inicie sesión en el Administrador Web CMS y vaya a la página SISTEMA > Servicios > Configuración SDK.
Hay 3 modos para CAYIN SDK

  1. Inhabilitar
  2. Habilitar sin clave de autenticación
  3. Habilitar con clave de autenticación
    • Manualmente (Predeterminado: 0000)
    • Generar uno al azar
Nota

Clave de autenticación: 4 – 64 caracteres del alfabeto ingles y números
Volver arriba

Uso del CAYIN SDK

Envíe una solicitud HTTP GET o POST al servidor web interno del SMP o CMS. Para enviar la solucitud puede diseñar su propio programa mediante casi cualquier lenguaje moderno. Si desea intentar enviar una solicitud HTTP GET al SMP/CMS, la manera más facil es ingresar el comando en la barra de direcciones de un navegador.
El siguiente es un ejemplo de cómo enviar un comando:

http://ip/cysdk/?cmd1=value1&cmd2=value2

Nota

“ip” es la dirección IP (o nombre de dominio) del SMP/CMS.

Interfaz API:

  • Soporta los métodos HTTP GET y POST
  • Un comando puede contener muchos atributos.
  • El caracter ‘;’´ separa cada atributo
  • El caracter ‘:’ separa cada valor de atributo
  • El caracter ‘&’ separa cada comando
  • Primero en la primera ejecución

Ejemplo: establecer la resolución de pantalla con comandos CySDK

http://ip/cysdk/?k=0000&dpyOutout=mode:distinct;rotate:left
&dpy1=output:HDMI1;size:1920x1080@60&dpy2=output:auto;size:1024x768

  • Autenticación: k=0000 (You can ignore it if you choose to disable the authentication)
  • Comando 1: dpyOutput=mode:distinct;rotate:left
    • Atributo 1: mode:distinct
    • Atributo 2: rotate:left
  • Comando 2: dpy1=output:HDMI1;size:1920x1080@60
    • Atributo 1: output:HDMI1
    • Atributo 2: size:1920x1080@60
  • Comando 3: dpy2=output:auto;size:1024x768
    • Atributo 1: output:auto
    • Atributo 2: size:1024x768

Resultado de Comando

El SMP/CMS responde con el código de estado HTTP al cliente o programa.

  • OK: devuelve el código 200 (OK) con una página html en blanco.
  • Error: devuelve código 500 (Error interno del servidor)
Nota

Para más información sobre códigos de estado HTTP, tenga como referencia la siguiente página de Wiki: http://en.wikipedia.org/wiki/List_of_HTTP_status_codes
Volver arriba

Funciones

CAYIN SDK le permite controlar las siguientes funciones:

  1. Autenticación de seguridad (clave de autenticación):
    Operación Atributos Valor Descripción
    k   Alfabetos y números
    • Clave: 4 – 64 caracteres del alfabeto inglés y números
    • UI: Sistema -> Servicio -> Configuración SDK >  Autenticación
  2. System control (SMP and CMS):
    Operación Atributos Valor Descripción
    sysRestart   0, 1

    0: Ninguna acción

    1: Reiniciar reproductor/servidor
  3. Display configuration (SMP only):
    Operación Atributos Valor Descripción
    dpyOutput mode single, clone, extended, distinct
    		  
    pos 1, 2

    Posición de pantalla:
    1: Arriba - Abajo
    2: Izquierda - Derecha

    *Sólo para modo extendido

    dpy1

    dpy2    		 output Auto, VGA, DVI, HDMI Configurar la salida de señal a la pantalla
    size WxH[i][@R] Establece la resolución de pantalla y refresh rate
    W: Ancho
    H: Altura
    i: Interlace (Opcional)
    @R: Refresh rate (Opcional)
    E.g.: 1920x1080@auto
    rotate 0, 1, 2 Rotación de pantalla:
    0: Ninguna rotación (Horizontal)
    1: 90° hacia la derecha (Vertical)
    2: 90° hacia la izquierta (Vertical)
    dpyPwSave   on
    off    		 Configurar encendido/apagado de la pantalla
    on: enciende la pantalla
    off: apaga la pantalla
  4. Configuración de entrada de video (sólo SMP):
    Operación Atributos Valor Descripción
    videoIn src internal, 1, 2
    		 interno: tarjeta de captura de video incorporado
    1, 2: dispositivo USB UVC externo
    std NTSC, PAL Estándar de Video
    bri 0, 1, …, 100 Brillo
    con 0, 1, …, 100 Contraste
    sat 0, 1, …, 100 Saturación
    overScan 0, 1, …, 100 Over scan
  5. Configuración de Sonido (sólo SMP):
    Operación Atributos Valor Descripción
    sndOutput   analog
    digital    		 Analógica: salida estéreo (conector jack o RCA)
    Digital: audio digital HDMI
    sound   0 – 100 Sólo para salida analógica
  6. Time configuration: (SMP & CMS)
    Operación Atributos Valor Descripción
    timeSetting date YYYYMMDDhhmmss,
    YYYYMMDD,
    hhmmss    		 Ejemplo:
    Configurar fecha: 20150209
    Configurar hora: 101530
    Configurar fecha y hora: 20150209101530
    timezone City or region name Vea apéndice para los nombres válidos
  7. Playback control (SMP):
    Operación Atributos Valor Descripción
    play skin [Skin Name] Nombre de Apariencia
    program [Program Name] Nombre de programa
    playlist [Playlist Name] Nombre de lista de reproducción
    centralctl 1 Programación Central
    display 1, 2 Escoger reproducción en pantalla 1 o pantalla 2 (sólo en el modo diferente del SMP-6000)
    pbVo1Play
    pbVo2Play    		 src file://file
    mms://url
    http://url
    rtb://[ip:]port
    rtp://ip:port
    src://local-all
    src://video-in
    src://usb-storage
    src://central-schedule    		  
    ratio auto (default), 4:3, 16:9  
    mute 0, 1  
    random 0, 1  
    display 1, 2 Establecer la zona en pantalla 1 o pantalla 2 (sólo en el modo diferente del SMP-6000)
    pbIm1Play
    pbIm2Play    		 src file://file
    src://local-all
    src://usb-storage
    src://central-schedule    		  
    duration 1-999 Duración de reproducción de cada imagen
    sequence forward
    backward
    random    		 Secuencia
    scale_fit 0
    1 (default)
    2    		 Ajustar para adaptar al área
    0: Inhabilitar
    1: Ajustar al área (Proporcionalmente)
    2: Ajustar al área (No Proporcional)
    transition_effect 0
    1
    2
    3
    4
    …
    255    		 0: Ningún efecto (predeterminado)
    1: Barrido hacia derecha (nombre previo: Izquierda a derecha)
    2: Barrido hacia izquierda (nombre previo: Derecha a izquierda)
    3: Barrido hacia abajo (nombre previo: Arriba a abajo)
    4: Barrido hacia arriba (nombre previo: Abajo a arriba)
    …
    255: Aleatorio
    Por favor tenga como referencia el manual de usuario online para la lista completa de todos los efectos transitorios.
    display 1, 2 Establecer la zona en pantalla 1 o pantalla 2 (sólo en el modo diferente del SMP-6000)
    pbTk1Play
    pbTk2Play    		 src text://file
    http://rss-feed
    rss://url
    src://file
    src://central-schedule    		  
    direction 1,2 1: Izquierda a Derecha
    2: Derecha a Izquierda
    font [font name]  
    fsize 10 to 200  
    fcolor [font color] Color de fuente predeterminado: 0xFFFFFF
    Ejemplo: 0x118A3F
    • El primer “11” significa color Rojo
    • En el medio “8A” significa color Verde
    • El último “3F” significa color Azul
    Todos los números usan valores hexadecimales
    bcolor [background color] Color de fondo predeterminado: 0x000000
    Ejemplo: 0x118A3F
    • El primer “11” significa color Rojo
    • En el medio “8A” significa color Verde
    • El último “3F” significa color Azul
    Todos los números usan valores hexadecimales
    seffect 1, 2, 3, 4 Efecto de desplazamiento del texto
    1: Sin efecto de desplazamiento
    2: Arrastre sencillo
    3: Abajo-arriba sencillo
    4: Abajo-arriba y arrastre
    speed 1, 2, 3, 4, 5, 6  
    pause 0, 0.5, 1, 1.5, 2, 2.5, 3 Pausa
    spacing 0, 0.25, 0.5, 1, 1.25, 1.5 Espaciado de Línea
    display 1, 2 Establecer la zona en pantalla 1 o pantalla 2 (sólo en el modo diferente del SMP-6000)
    pbHtm1Play
    pbHtm2Play
    pbHtm3Play    		 src file://file
    http://url
    https://url
    twitter://user
    weather://id
    central-schedule    		  
    template 0, 1, … , 12 Twitter
    title [title] Twitter
    subject [subject] Twitter
    size 250x75
    285x170
    550x230    		 Clima
    fcolor [foreground color] Clima
    bcolor [background color] Clima
    effect 0, 1 Clima
    units 0, 1 Clima
    pause 0-9 Clima
    icons 0, 1 Clima
    display 1, 2 Establecer la zona en pantalla 1 o pantalla 2 (sólo en el modo diferente del SMP-6000)
    pbAttr scrollbar auto, hide  
    hwaccel 0, 1 0: apagado, 1: encendido
    flashver 9, 11 Flash versión 9 o 11
    autoUpdate 1-999
    disable    		  
  8. Configuración RTB (sólo CMS)
    Operación Atributos Valor Descripción
    rtb channel 1, 2 Puerto de entrada
    active enable
    disable    		  
    port UDP port number 8100, 8102, ..., 8226
    input composite
    s-video    		  
    std NTSC, PAL  
    bri 0,1…,100  
    con 0,1…,100  
    sat 0,1…,100  
    format mpeg2, mpeg4  
    bit 256k, 512k, 1M, 2M, 3M,  4M, 5M  
    bocast 1/enable
    0/disable    		 1: habilitar
    0: inhabilitar
    mtcast ip, disable Multidifusión
    uncast ip, enable, disable Unidifusión

Ejemplo

  1. Clave de Autenticación:
    Procesa un comando CAYIN SDK con clave de protección
    http://<ip>/cysdk/?k=0123456789abcdef;play=skin:skin-1
    Procesa un comando CAYIN SDK sin clave de protección
    http://<ip>/cysdk/?play=skin:skin-1
  2. Control de Sistema:
    Reinicia su sistema
    http://<ip>/cysdk/?sysRestart=1
  3. Configuración de Pantalla:
    Establece la configuración de pantalla a modo clónico y establece la Pantalla 1 a resolución 1920x1080i.
    http://<ip>/cysdk/?dpyOutput=mode:clone&dpy1=output:HDMI;size:1920x1080i@60;rotate:0
  4. Configuración de entrada de video:
    Configura la fuente de entrada de video desde la tarjeta de captura de video con NTSC
    http://<ip>/cysdk/?videoIn=src:internal;std:NTSC;bri:50;con:50;sat:50;overScan:0
  5. Sonido:
    Cambia la salida de sonido a salida analógica
    http://<ip>/cysdk/?sndOutput=analog
  6. Reproducción:
    Cambia la reproducción a “apariencia-1”
    http://<ip>/cysdk/?play=skin:skin-1;display:1
    Configura la zona de imagen 1 a reproducir un archivo y una carpeta en carpeta multimedia
    http://<ip>/cysdk/?pbIm1Play=src:file://file1.jpg;src:file://folder/;duration:1
    Configura la zona de ticker 1 a reproducir un RSS
    http://<ip>/cysdk/?pbTk1Play=rss://url;seffect:1
    Configura la zona HTML 1 a reproducir un archivo en carpeta multimedia
    http://<ip>/cysdk/?pbHtm1Play=src:file://file1.html
    Cambia al Adobe Flash player a versión 9
    http://<ip>/cysdk/?pbAttr=flashver:9
  7. RTB (CMS):
    Habilita la unidifusión del canal 1 con MPEG-4@512k bps rate a la dirección “192.168.1.2”.
    http://<ip>/cysdk/?rtb=channel:1;active:enable;input:composite;format:mpeg4;bit:512k;uncast:192.168.1.2
Volver arriba

Apéndice: ciudades válidas para configuración de zona horaria

(GMT-12:00) Eniwetok, Kwajalein
(GMT-11:00) MidwayIsland, Samoa
(GMT-10:00) Hawaii
(GMT-09:00) Alaska
(GMT-08:00) Pacific Time (US & Canada); Tijuana
(GMT-07:00) Arizona
(GMT-07:00) Mountain Time (US & Canada)
(GMT-06:00) Central Time (US & Canada)
(GMT-06:00) Mexico City, Tegucigalpa
(GMT-06:00) Saskatchewan
(GMT-05:00) Bogota, Lima, Quito
(GMT-05:00) Eastern Time (US & Canada)
(GMT-05:00) Indiana (East)
(GMT-04:00) Atlantic Time (Canada)
(GMT-04:00) Caracas, La Paz
(GMT-04:00) Santiago
(GMT-03:30) Newfoundland
(GMT-03:00) Brasilia
(GMT-03:00) Buenos Aires, Georgetown
(GMT-02:00) Mid-Atlantic
(GMT-01:00) Azores, Cape Verde Is.
(GMT) Casablanca, Monrovia
(GMT) Greenwich Mean Time: Dublin, Edinburgh, Lisbon, London
(GMT+01:00) Amsterdam, Berlin, Bern, Rome, Stockholm, Vienna
(GMT+01:00) Belgrade, Bratislava, Budapest, Ljubljana, Prague
(GMT+01:00) Brussels, Copenhagen, Madrid, Paris, Vilnius
(GMT+01:00) Sarajevo, Skopje, Sofija, Warsaw, Zagreb
(GMT+02:00) Athens, Istanbul, Minsk
(GMT+02:00) Bucharest
(GMT+02:00) Cairo
(GMT+02:00) Harare, Pretoria
(GMT+02:00) Helsinki, Riga, Tallinn
(GMT+02:00) Israel
(GMT+03:00) Baghdad, Kuwait, Riyadh
(GMT+03:00) Moscow, St. Petersburg, Volgograd
(GMT+03:00) Nairobi
(GMT+03:30) Tehran
(GMT+04:00) Abu Dhabi, Muscat
(GMT+04:00) Baku, Tbilisi
(GMT+04:30) Kabul
(GMT+05:00) Eekaterinburg
(GMT+05:00) Islamabad, Karachi, Tashkent
(GMT+05:30) Bombay, Calcutta, Madras, New Delhi
(GMT+06:00) Almaty, Dhaka
(GMT+06:00) Colombo
(GMT+07:00) Bangkok, Hanoi, Jakarta
(GMT+08:00) Beijing, Chongqing, Hong Kong, Urumqi
(GMT+08:00)  Perth
(GMT+08:00) Singapore
(GMT+08:00) Taipei
(GMT+09:00) Osaka, Sapporo, Tokyo
(GMT+09:00) Seoul
(GMT+09:00) Yakutsk
(GMT+09:30) Adelaide
(GMT+09:30) Darwin
(GMT+10:00) Brisbane
(GMT+10:00) Canberra, Melbourne, Sydney
(GMT+10:00) Guam, Port Moresby
(GMT+10:00) Hobart
(GMT+10:00) Vladivostok
(GMT+11:00) Magadan, Solomon Is., New Caledonia
(GMT+12:00) Auckland, Wellington
(GMT+12:00) Fiji, Kamchatka, Marshall Is.

Ejemplo:

http://<ip>/cysdk/?timeSetting=timezone:Eastern Time
http://<ip>/cysdk/?timeSetting=timezone:London
http://<ip>/cysdk/?timeSetting=timezone:Taipei

Volver arriba