################
ISteamRemotePlay
################

.. 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
-----------------

* :func:`RemotePlay.BEnableRemotePlayTogetherDirectInput`
* :func:`RemotePlay.BGetSessionClientResolution`
* :func:`RemotePlay.BSendRemotePlayTogetherInvite`
* :func:`RemotePlay.BSessionRemotePlayTogether`
* :func:`RemotePlay.CreateMouseCursor`
* :func:`RemotePlay.DisableRemotePlayTogetherDirectInput`
* :func:`RemotePlay.GetInput`
* :func:`RemotePlay.GetLargeSessionAvatar`
* :func:`RemotePlay.GetMediumSessionAvatar`
* :func:`RemotePlay.GetSessionClientFormFactor`
* :func:`RemotePlay.GetSessionClientName`
* :func:`RemotePlay.GetSessionCount`
* :func:`RemotePlay.GetSessionGuestID`
* :func:`RemotePlay.GetSessionID`
* :func:`RemotePlay.GetSessionSteamID`
* :func:`RemotePlay.GetSmallSessionAvatar`
* :func:`RemotePlay.SetMouseCursor`
* :func:`RemotePlay.SetMousePosition`
* :func:`RemotePlay.SetMouseVisibility`
* :func:`RemotePlay.ShowRemotePlayTogetherUI`

List of Callbacks
-----------------

* :func:`RemotePlay.OnSteamRemotePlaySessionConnected`
* :func:`RemotePlay.OnSteamRemotePlaySessionDisconnected`
* :func:`RemotePlay.OnSteamRemotePlayTogetherGuestInvite`
* :func:`RemotePlay.OnSteamRemotePlaySessionAvatarLoaded`

Function Reference
------------------

.. function:: RemotePlay.BEnableRemotePlayTogetherDirectInput()

    🤖 **Auto-generated binding**

    :returns: (bool) Return value
    :SteamWorks: `BEnableRemotePlayTogetherDirectInput <https://partner.steamgames.com/doc/api/ISteamRemotePlay#BEnableRemotePlayTogetherDirectInput>`_

.. function:: RemotePlay.BGetSessionClientResolution(unSessionID)

    🤖 **Auto-generated binding**

    :param int - RemotePlaySessionID_t unSessionID:
    :returns: (bool) Return value
    :returns: (int) ``pnResolutionX``
    :returns: (int) ``pnResolutionY``
    :SteamWorks: `BGetSessionClientResolution <https://partner.steamgames.com/doc/api/ISteamRemotePlay#BGetSessionClientResolution>`_

    **Signature differences from C++ API:**

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

.. function:: RemotePlay.BSendRemotePlayTogetherInvite(steamIDFriend)

    🤖 **Auto-generated binding**

    :param uint64 - CSteamID steamIDFriend:
    :returns: (bool) Return value
    :SteamWorks: `BSendRemotePlayTogetherInvite <https://partner.steamgames.com/doc/api/ISteamRemotePlay#BSendRemotePlayTogetherInvite>`_

**Example**::

    if Steam.RemotePlay.BSendRemotePlayTogetherInvite(friendSteamID) then
        print('Remote Play Together invite sent')
    end

.. function:: RemotePlay.BSessionRemotePlayTogether(unSessionID)

    🤖 **Auto-generated binding**

    :param int - RemotePlaySessionID_t unSessionID:
    :returns: (bool) Return value
    :SteamWorks: `BSessionRemotePlayTogether <https://partner.steamgames.com/doc/api/ISteamRemotePlay#BSessionRemotePlayTogether>`_

.. function:: RemotePlay.CreateMouseCursor(nWidth, nHeight, nHotX, nHotY, pBGRA, nPitch)

    🤖 **Auto-generated binding**

    :param int nWidth:
    :param int nHeight:
    :param int nHotX:
    :param int nHotY:
    :param str? pBGRA:
    :param int nPitch:
    :returns: (int - RemotePlayCursorID_t) Return value
    :SteamWorks: `CreateMouseCursor <https://partner.steamgames.com/doc/api/ISteamRemotePlay#CreateMouseCursor>`_

.. function:: RemotePlay.DisableRemotePlayTogetherDirectInput()

    🤖 **Auto-generated binding**

    :SteamWorks: `DisableRemotePlayTogetherDirectInput <https://partner.steamgames.com/doc/api/ISteamRemotePlay#DisableRemotePlayTogetherDirectInput>`_

.. function:: RemotePlay.GetInput(unMaxEvents)

    🤖 **Auto-generated binding**

    :param int? unMaxEvents: size of the buffer to allocate for ``pInput``. If ``nil`` then the buffer will be ``NULL``.
    :returns: (int) Return value
    :returns: (:ref:`RemotePlayInput_t <struct-RemotePlayInput_t>`\ []) ``pInput``
    :SteamWorks: `GetInput <https://partner.steamgames.com/doc/api/ISteamRemotePlay#GetInput>`_

    **Signature differences from C++ API:**

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

**Example**::

    local nInputs = Steam.RemotePlay.GetInput(nil)
    local _, inputs = Steam.RemotePlay.GetInput(nInputs)
    for _, input in ipairs(inputs) do
        processInput(input)
    end

.. function:: RemotePlay.GetLargeSessionAvatar(unSessionID)

    🤖 **Auto-generated binding**

    :param int - RemotePlaySessionID_t unSessionID:
    :returns: (int) Return value
    :SteamWorks: `GetLargeSessionAvatar <https://partner.steamgames.com/doc/api/ISteamRemotePlay#GetLargeSessionAvatar>`_

.. function:: RemotePlay.GetMediumSessionAvatar(unSessionID)

    🤖 **Auto-generated binding**

    :param int - RemotePlaySessionID_t unSessionID:
    :returns: (int) Return value
    :SteamWorks: `GetMediumSessionAvatar <https://partner.steamgames.com/doc/api/ISteamRemotePlay#GetMediumSessionAvatar>`_

.. function:: RemotePlay.GetSessionClientFormFactor(unSessionID)

    🤖 **Auto-generated binding**

    :param int - RemotePlaySessionID_t unSessionID:
    :returns: (int - ESteamDeviceFormFactor) Return value
    :SteamWorks: `GetSessionClientFormFactor <https://partner.steamgames.com/doc/api/ISteamRemotePlay#GetSessionClientFormFactor>`_

**Example**::

    local formFactor = Steam.RemotePlay.GetSessionClientFormFactor(sessionID)
    if formFactor == Steam.k_ESteamDeviceFormFactor_Phone then
        print('Client is on a mobile device')
    end

.. function:: RemotePlay.GetSessionClientName(unSessionID)

    🤖 **Auto-generated binding**

    :param int - RemotePlaySessionID_t unSessionID:
    :returns: (str) Return value
    :SteamWorks: `GetSessionClientName <https://partner.steamgames.com/doc/api/ISteamRemotePlay#GetSessionClientName>`_

    **Notes:**

    * See :func:`RemotePlay.GetSessionID`'s example.

.. function:: RemotePlay.GetSessionCount()

    🤖 **Auto-generated binding**

    :returns: (int) Return value
    :SteamWorks: `GetSessionCount <https://partner.steamgames.com/doc/api/ISteamRemotePlay#GetSessionCount>`_

**Example**::

    local count = Steam.RemotePlay.GetSessionCount()
    print('Active Remote Play sessions:', count)

.. function:: RemotePlay.GetSessionGuestID(unSessionID)

    🤖 **Auto-generated binding**

    :param int - RemotePlaySessionID_t unSessionID:
    :returns: (int) Return value
    :SteamWorks: `GetSessionGuestID <https://partner.steamgames.com/doc/api/ISteamRemotePlay#GetSessionGuestID>`_

.. function:: RemotePlay.GetSessionID(iSessionIndex)

    🤖 **Auto-generated binding**

    :param int iSessionIndex:
    :returns: (int - RemotePlaySessionID_t) Return value
    :SteamWorks: `GetSessionID <https://partner.steamgames.com/doc/api/ISteamRemotePlay#GetSessionID>`_

**Example**::

    local count = Steam.RemotePlay.GetSessionCount()
    for i = 0, count - 1 do
        local sessionID = Steam.RemotePlay.GetSessionID(i)
        local name = Steam.RemotePlay.GetSessionClientName(sessionID)
        print('Remote Play client:', name)
    end

.. function:: RemotePlay.GetSessionSteamID(unSessionID)

    🤖 **Auto-generated binding**

    :param int - RemotePlaySessionID_t unSessionID:
    :returns: (uint64 - CSteamID) Return value
    :SteamWorks: `GetSessionSteamID <https://partner.steamgames.com/doc/api/ISteamRemotePlay#GetSessionSteamID>`_

**Example**::

    local steamID = Steam.RemotePlay.GetSessionSteamID(sessionID)
    print('Remote player:', Steam.Friends.GetFriendPersonaName(steamID))

.. function:: RemotePlay.GetSmallSessionAvatar(unSessionID)

    🤖 **Auto-generated binding**

    :param int - RemotePlaySessionID_t unSessionID:
    :returns: (int) Return value
    :SteamWorks: `GetSmallSessionAvatar <https://partner.steamgames.com/doc/api/ISteamRemotePlay#GetSmallSessionAvatar>`_

.. function:: RemotePlay.SetMouseCursor(unSessionID, unCursorID)

    🤖 **Auto-generated binding**

    :param int - RemotePlaySessionID_t unSessionID:
    :param int - RemotePlayCursorID_t unCursorID:
    :SteamWorks: `SetMouseCursor <https://partner.steamgames.com/doc/api/ISteamRemotePlay#SetMouseCursor>`_

.. function:: RemotePlay.SetMousePosition(unSessionID, flNormalizedX, flNormalizedY)

    🤖 **Auto-generated binding**

    :param int - RemotePlaySessionID_t unSessionID:
    :param float flNormalizedX:
    :param float flNormalizedY:
    :SteamWorks: `SetMousePosition <https://partner.steamgames.com/doc/api/ISteamRemotePlay#SetMousePosition>`_

.. function:: RemotePlay.SetMouseVisibility(unSessionID, bVisible)

    🤖 **Auto-generated binding**

    :param int - RemotePlaySessionID_t unSessionID:
    :param bool bVisible:
    :SteamWorks: `SetMouseVisibility <https://partner.steamgames.com/doc/api/ISteamRemotePlay#SetMouseVisibility>`_

.. function:: RemotePlay.ShowRemotePlayTogetherUI()

    🤖 **Auto-generated binding**

    :returns: (bool) Return value
    :SteamWorks: `ShowRemotePlayTogetherUI <https://partner.steamgames.com/doc/api/ISteamRemotePlay#ShowRemotePlayTogetherUI>`_


Callbacks
---------

.. function:: RemotePlay.OnSteamRemotePlaySessionConnected

    Callback for `SteamRemotePlaySessionConnected_t <https://partner.steamgames.com/doc/api/ISteamRemotePlay#SteamRemotePlaySessionConnected_t>`_

    **callback(data)** receives:

    * **data.m_unSessionID** *(int - RemotePlaySessionID_t)*

**Example**::

    function Steam.RemotePlay.OnSteamRemotePlaySessionConnected(data)
        local name = Steam.RemotePlay.GetSessionClientName(data.m_unSessionID)
        print('Remote Play session connected:', name)
    end

.. function:: RemotePlay.OnSteamRemotePlaySessionDisconnected

    Callback for `SteamRemotePlaySessionDisconnected_t <https://partner.steamgames.com/doc/api/ISteamRemotePlay#SteamRemotePlaySessionDisconnected_t>`_

    **callback(data)** receives:

    * **data.m_unSessionID** *(int - RemotePlaySessionID_t)*

**Example**::

    function Steam.RemotePlay.OnSteamRemotePlaySessionDisconnected(data)
        print('Remote Play session disconnected:', data.m_unSessionID)
    end

.. function:: RemotePlay.OnSteamRemotePlayTogetherGuestInvite

    Callback for `SteamRemotePlayTogetherGuestInvite_t <https://partner.steamgames.com/doc/api/ISteamRemotePlay#SteamRemotePlayTogetherGuestInvite_t>`_

    **callback(data)** receives:

    * **data.m_szConnectURL** *(string)*

.. function:: RemotePlay.OnSteamRemotePlaySessionAvatarLoaded

    Callback for `SteamRemotePlaySessionAvatarLoaded_t <https://partner.steamgames.com/doc/api/ISteamRemotePlay#SteamRemotePlaySessionAvatarLoaded_t>`_

    **callback(data)** receives:

    * **data.m_unSessionID** *(int - RemotePlaySessionID_t)*
    * **data.m_iImage** *(int)*
    * **data.m_iWide** *(int)*
    * **data.m_iTall** *(int)*