ISteamVideo

Note

This documentation is auto-generated. Methods marked with 🤖 are automatically generated bindings. Methods marked with ✍️ are manually implemented and methods marked with ✋ are currently not implemented.

List of Functions

Video.GetOPFSettings()
Video.GetOPFStringForApp()
Video.GetVideoURL()
Video.IsBroadcasting()

Function Reference

Video.GetOPFSettings(unVideoAppID)

🤖 Auto-generated binding

Parameters:: unVideoAppID (int - AppId_t) –
SteamWorks:: GetOPFSettings

Video.GetOPFStringForApp(unVideoAppID, pnBufferSize)

🤖 Auto-generated binding

Parameters:

unVideoAppID (int - AppId_t) –
pnBufferSize (int?) – size of the buffer to allocate for pchBuffer. If nil then the buffer will be NULL.

Returns:

(bool) Return value

Returns:

(str) pchBuffer

Returns:

(int) pnBufferSize

SteamWorks:

GetOPFStringForApp

Signature differences from C++ API:

Parameter pchBuffer is not a parameter in Lua — it is an output-only pointer in C++ and is returned as an additional return value.
Parameter pnBufferSize is both an input and an output in C++: you pass the buffer size, and Steam writes the actual count back. luasteam returns it as an additional return value.

Video.GetVideoURL(unVideoAppID)

🤖 Auto-generated binding

Parameters:: unVideoAppID (int - AppId_t) –
SteamWorks:: GetVideoURL

Example:

Steam.Video.GetVideoURL(videoAppID)
-- Wait for OnGetVideoURLResult callback

Video.IsBroadcasting()

🤖 Auto-generated binding

Returns:: (bool) Return value
Returns:: (int) pnNumViewers
SteamWorks:: IsBroadcasting

Signature differences from C++ API:

Parameter pnNumViewers is not a parameter in Lua — it is an output-only pointer in C++ and is returned as an additional return value.

Example:

local broadcasting, viewers = Steam.Video.IsBroadcasting()
if broadcasting then
    print('Broadcasting to', viewers, 'viewers')
end

Callbacks

Video.OnGetVideoURLResult()

Callback for GetVideoURLResult_t

callback(data) receives:

data.m_eResult (int - EResult)
data.m_unVideoAppID (int - AppId_t)
data.m_rgchURL (string)

Example:

function Steam.Video.OnGetVideoURLResult(data)
    if data.m_eResult == Steam.k_EResultOK then
        print('Video URL:', data.m_rgchURL)
        openVideoPlayer(data.m_rgchURL)
    end
end

Video.OnGetOPFSettingsResult()

Callback for GetOPFSettingsResult_t

callback(data) receives:

data.m_eResult (int - EResult)
data.m_unVideoAppID (int - AppId_t)

Video.OnBroadcastUploadStart()

Callback for BroadcastUploadStart_t

callback(data) receives:

data.m_bIsRTMP (bool)

Example:

function Steam.Video.OnBroadcastUploadStart()
    print('Broadcast started')
end

Video.OnBroadcastUploadStop()

Callback for BroadcastUploadStop_t

callback(data) receives:

data.m_eResult (int - EBroadcastUploadResult)