Documentación de Steamworks
Interfaz ISteamVideo
Proporciona funciones para interactuar con las plataformas de vídeo y retransmisión de Steam.

Consulta features/streaming_video para obtener más información.

Funciones miembro

Las funciones miembro para ISteamVideo se llaman a través de la función de acceso global SteamVideo().

GetOPFSettings

void GetOPFSettings( AppId_t unVideoAppID );
NombreTipoDescripción
unVideoAppIDAppId_tId. de aplicación del vídeo del que se obtiene la información FPA.

Obtiene la información FPA para la reproducción de vídeo 360.

Para recuperar los datos FPA (Formato de Proyección Abierta) 360 con el fin de reproducir un vídeo 360, se empieza por llamar a esta función y después una función callback indicará si la solicitud se realizó correctamente. Si tuvo éxito, los datos reales de OPF JSON se pueden recuperar con una llamada a GetOPFStringForApp.

Devuelve: void
Activa una GetOPFSettingsResult_t función callback.

GetOPFStringForApp

bool GetOPFStringForApp( AppId_t unVideoAppID, char *pchBuffer, int32 *pnBufferSize );
NombreTipoDescripción
unVideoAppIDAppId_tId. de la aplicación de vídeo para el que se obtiene la cadena OPF.
pchBufferchar *Devuelve la cadena FPA escribiéndola en este búfer.
pnBufferSizeint32 *Esto se debe establecer en el tamaño de pchBuffer y devuelve el número de bytes escritos en pchBuffer.

Obtiene la cadena FPA para el id. de aplicación del vídeo especificado.

Una vez que se ha realizado la función callback para GetOPFSettingsResult_t y el resultado indica su correcta ejecución, esta llamada devolverá los datos FPA reales en formato JSON. El tamaño de la cadena FPA varía, pero en este punto 48 000 bytes deberían ser suficientes para contener toda la cadena. Si no lo está, pnBufferSize se establecerá en el tamaño requerido. En ese caso, habrá de hacerse una segunda llamada con el tamaño de búfer correcto.

NOTA: los datos devueltos en una llamada a GetOPFStringForApp() realizada correctamente solo pueden recuperarse una vez. Si necesita recuperarlo varias veces, deberá hacer una llamada a GetOPFSettings cada vez.

Devuelve: bool
true si tenemos los detalles de OPF de una llamada anterior a GetOPFSettings, de lo contrario false.

Devuelve los detalles en pchBuffer.

Para obtener una descripción del formato OPF y una respuesta de ejemplo, consulta la página web OPV de Pixvana.

GetVideoURL

void GetVideoURL( AppId_t unVideoAppID );
NombreTipoDescripción
unVideoAppIDAppId_tId. de aplicación del vídeo para el que se va a recibir la retransmisión de vídeo.

Obtiene de forma asíncrona la URL apropiada para la retransmisión de vídeo asociada al id. de aplicación del vídeo especificado.

Devuelve: void
Activa una GetVideoURLResult_t función callback.


Véase también: DASH en Wikipedia

IsBroadcasting

bool IsBroadcasting( int *pnNumViewers );
NombreTipoDescripción
pnNumViewersint *Devuelve el número de espectadores que están siguiendo actualmente la retransmisión en vivo.

Comprueba si el usuario está realizando actualmente una retransmisión en vivo y obtiene el número de usuarios.

Devuelve: bool
true si el usuario está cargando una transmisión en vivo, de lo contrario, false.

Devuelve el número de espectadores a través de pnNumViewers si el usuario está transmitiendo actualmente.

Devoluciones de llamada

Estas son funciones callback que pueden activarse llamando a SteamAPI_RunCallbacks. Muchas de estas se activarán directamente en respuesta a las funciones miembro de ISteamVideo.

BroadcastUploadStart_t

Se llama automáticamente cuando el usuario inicia una retransmisión.

Esta función callback no tiene campos.

BroadcastUploadStop_t

Se llama automáticamente cuando el usuario interrumpe una retransmisión.

NombreTipoDescripción
m_eResultEBroadcastUploadResultRazón por la que se interrumpió la retransmisión.

GetOPFSettingsResult_t

Se activa cuando se recuperan los detalles de OPF para la reproducción de vídeo 360.
Después de recibir esto, puedes usar GetOPFStringForApp para acceder a los detalles de OPF.

NombreTipoDescripción
m_eResultEResultEl resultado de la operación.
Valores posibles:
m_unVideoAppIDAppId_tId. de aplicación del vídeo del que obtuvimos la información.

Funciones asociadas: GetOPFSettings

GetVideoURLResult_t

Proporciona el resultado de una llamada a GetVideoURL.

NombreTipoDescripción
m_eResultEResultResultado de la operación.
  • k_EResultOK si la llamada es exitosa.
  • k_EResultInvalidParam si la id. de la aplicación proporcionada no es una id. de la aplicación de vídeo o si el usuario no posee una licencia para ella.
m_unVideoAppIDAppId_tEl id. de aplicación proporcionado en la llamada original a GetVideoURL.
m_rgchURLchar[256]Si la llamada fue exitosa, contiene la URL del MPEG-DASH Standard documento XML con formato que se puede usar para transmitir el contenido.

Funciones asociadas: GetVideoURL

Constantes

Estas son constantes definidas para usarse con ISteamVideo.

NombreTipoValorDescripción
STEAMVIDEO_INTERFACE_VERSIONconst char *"STEAMVIDEO_INTERFACE_V002"