Steamworks-dokumentation
ISteamVideo-grænseflade
Giver funktioner til at kommunikere med Steam-video og broadcasting-platforme.

Se features/streaming_video for mere information.

Medlemsfunktioner

Medlemsfunktioner for ISteamVideo kaldes gennem den globale accessor-funktion SteamVideo().

GetOPFSettings

void GetOPFSettings( AppId_t unVideoAppID );
NavnTypeBeskrivelse
unVideoAppIDAppId_tApp-ID'et for videoen, som OPF-detaljerne skal hentes til.

Hent OPF-detaljer for 360-videoafspilning

For at hente 360-OPF-dataene (Open Projection Format) for at afspille en 360-video, skal du starte med at kalde denne parameter. Derefter vil tilbagekaldet indikere, om anmodningen lykkedes eller ej. Hvis det lykkedes, kan OPF-dataene i JSON hentes med et kald til GetOPFStringForApp.

Returværdier: void
Udløser et GetOPFSettingsResult_t-tilbagekald.

GetOPFStringForApp

bool GetOPFStringForApp( AppId_t unVideoAppID, char *pchBuffer, int32 *pnBufferSize );
NavnTypeBeskrivelse
unVideoAppIDAppId_tApp-ID'et for videoen, som OPF-strengen skal hentes til.
pchBufferchar *Returnerer OPF-strengen ved at skrive den til denne buffer.
pnBufferSizeint32 *Denne skal sættes til størrelsen af pchBuffer og returnerer antallet af bytes, som skrives til pchBuffer.

Får OPF-strengen for det angivne app-ID for videoen.

Når tilbagekaldet for GetOPFSettingsResult_t er rejst, og EResult indikerer, at det lykkedes, vil et kald til denne parameter returnere OPF-dataene i JSON-format. Størrelsen af OPF-strengen varierer, men på nuværende tidspunkt burde 48.000 bytes være nok til at indeholde hele strengen. Ellers vil pnBufferSize blive indstillet til den nødvendige størrelse. I så fald skal du foretage et nyt kald med den rigtige bufferstørrelse.

BEMÆRK: De data, der returneres i et vellykket kald til GetOPFStringForApp(), kan kun hentes én gang. Hvis du har brug for at hente dem flere gange, skal du kalde GetOPFSettings hver gang.

Returværdier: bool
true – hvis vi har OPF-detaljerne fra et tidligere kald til GetOPFSettings, ellers false.

Returnerer detaljerne i pchBuffer.

For a description of the OPF format and an example response, please see the Pixvana OPF web page.

GetVideoURL

void GetVideoURL( AppId_t unVideoAppID );
NavnTypeBeskrivelse
unVideoAppIDAppId_tApp-ID'et for videoen, som skal modtage videostreamen.

Får asynkront den egnede URL til streaming af videoen, som er forbundet med det angivne app-ID for videoen.

Returværdier: void
Triggers a GetVideoURLResult_t callback.


Se også: DASH on Wikipedia

IsBroadcasting

bool IsBroadcasting( int *pnNumViewers );
NavnTypeBeskrivelse
pnNumViewersint *Returnerer antallet af seere, som i øjeblikket ser den direkte broadcast.

Tjekker, om brugeren broadcaster direkte i øjeblikket og får antallet af brugere.

Returværdier: bool
true – hvis brugeren er ved at uploade en direkte broadcast, ellers false.

Returnerer antallet af seere via pnNumViewers, hvis brugeren broadcaster i øjeblikket.

Tilbagekald

Disse er tilbagekald, som kan aktiveres ved at kalde SteamAPI_RunCallbacks. Mange af disse vil blive udløst direkte som svar på medlemsfunktioner tilhørende ISteamVideo.

BroadcastUploadStart_t

Kaldes automatisk, når brugeren begynder at broadcaste.

Dette tilbagekald har ingen felter.

BroadcastUploadStop_t

Kaldes automatisk, når brugeren stopper med at broadcaste.

NavnTypeBeskrivelse
m_eResultEBroadcastUploadResultÅrsagen til, at broadcasten stoppede.

GetOPFSettingsResult_t

Udløses, når OPF-detaljerne for 360-videoafspilning hentes.
Når du modtager dette, kan du bruge GetOPFStringForApp til at tilgå OPF-detaljerne.

NavnTypeBeskrivelse
m_eResultEResultResultatet af handlingen.
Mulige værdier:
m_unVideoAppIDAppId_tApp-ID'et på videoen, som vi har detaljer om.

Tilknyttede funktioner: GetOPFSettings

GetVideoURLResult_t

Giver resultatet af et kald til GetVideoURL.

NavnTypeBeskrivelse
m_eResultEResultResultatet af handlingen.
m_unVideoAppIDAppId_tApp-ID'et i det oprindelige kald til GetVideoURL.
m_rgchURLchar[256]If the call was successful this contains the URL to the MPEG-DASH Standard schema formatted xml document which can be used to stream the content.

Tilknyttede funktioner: GetVideoURL

Konstanter

Det følgende er konstanter, som defineres til brug med ISteamVideo.

NavnTypeVærdiBeskrivelse
STEAMVIDEO_INTERFACE_VERSIONconst char *"STEAMVIDEO_INTERFACE_V002"