-
Notifications
You must be signed in to change notification settings - Fork 19
IMixerInteractivityModule
Interface for Mixer Interactivity features. Exposes user authentication, state control, and remote events for consumption by C++ game code.
A singleton-like access to this module's interface. This is purely for convenience. Be aware of calling this during the shutdown phase. Your module might have been unloaded already.
Returns singleton instance, loading the module on demand if needed
Checks to see if this module is loaded and ready. It is only valid to call Get() if IsAvailable() returns true.
True if the module is loaded and ready to use.
Sign a local user into the Mixer service without displaying UI. The operation will fail if user interaction. would be required to complete sign-in. The operation takes place asynchronously, with changes reported via the OnLoginStateChanged event.
Network id for the local user whose identity will be used for Mixer login.
True if a login attempt was started; results will be reported via OnLoginStateChanged.
Sign a local user into the Mixer service displaying OAuth login UI if necessary. UI will be hosted in a default-styled popup window. The operation takes place asynchronously, with changes reported via the OnLoginStateChanged event. Not supported on all platforms.
Network id for the local user whose identity will be used for Mixer login.
True if a login attempt was started; results will be reported via OnLoginStateChanged.
Sign a local user into the Mixer service using an authorization code obtained by the title through an external mechanism (e.g. Mixer shortcode authentication flow). The operation takes place asynchronously, with changes reported via the OnLoginStateChanged event.
The game-obtained OAuth authorization code.
Network id for the local user whose identity will be used for Mixer login.
True if a login attempt was started; results will be reported via OnLoginStateChanged.
Reports whether a user is currently logged in to Mixer, or if a login/logout operation is in progress.
The login state of the user.
Reports whether a user is currently logged in to Mixer, or if a login/logout operation is in progress.
The login state of the user.
Notify the Mixer service that the game is ready for interactive input. The operation takes place asynchronously, with changes reported via the OnInteractivityStateChanged event.
Notify the Mixer service that the game is no longer accepting interactive input. The operation takes place asynchronously, with changes reported via the OnInteractivityStateChanged event.
Reports the current interactivity state.
The login state of the user.
Request a change in the interactive scene displayed to remote users.
Name of the new interactive scene to display.
Name of the group to whom the new scene should be shown. Default group if empty.
True if a login attempt was started; results will be reported via OnLoginStateChanged.
Name of the group whose scene should be returned. Default group if empty.
Name of the group whose scene should be returned. Default group if empty.
Name if the interactive scene currently displayed.
Request that the named button enter a cooldown state for the specified period. While cooling down the button will be non-interactive.
Name of the button that should be on cooldown.
Duration for which the button should be non-interactive.
Retrieve information about a named button that is independent of its current state. Information includes the display text and spark cost.
Name of the button for which information should be returned.
Out parameter filled in with information about the button upon success.
True if button was found and OutDesc is valid.
Retrieve information about a named button that is dependent on remote user and title interactions.
Name of the button for which information should be returned.
Out parameter filled in with information about the button upon success.
True if joystick was found and OutDesc is valid.
Retrieve information about a named joystick that is independent of its current state.
Name of the joystick for which information should be returned.
Out parameter filled in with information about the joystick upon success.
True if button was found and OutState is valid.
Retrieve information about a named joystick that is dependent on remote user and title interactions. This includes x and y axis information.
Name of the joystick for which information should be returned.
Out parameter filled in with information about the joystick upon success.
True if joystick was found and OutState is valid.
Retrieve a structure describing the local user currently signed in to the Mixer service.
Returns the Mixer user. Invalid shared pointer when no user is signed in.
Retrieve a structure describing a remote user currently interacting with the title on the Mixer service.
Mixer id of the remote user.
Returns the Mixer user object with the given ID. Invalid shared pointer when no user could be found.
Create a user group with the given name. Groups may be used to show different scenes to different segments of the participating audience. No-op if the group already exists.
Name for the new group.
Interactive scene that this new group should see.
True if group is newly created. False if it already existed (interactive scene will not be changed).
Retrieve the collection of participants that belong to the named group.
Name of the group for which to retrieve participants.
Out parameter filled with the members of the named group.
True if the group exists (even if it is empty). False otherwise.
Move a single participant to the named group.
Name of the group for which to retrieve participants.
Name of the group for which to retrieve participants.
True if the destination group exists. False otherwise.
Captures a given interactive event transaction, charging the sparks to the appropriate remote participant.
Id of the transaction for which sparks should be charged (obtained from event).
Occurs when the state of the logged in user has changed.
Occurs when the interactivity state of the Mixer service has changed. For instance, the state would change to EMixerInteractivityState::Interactive if there was a call to StartInteractivity and the channel's interactive controls are enabled.
Occurs when the state of a participant has changed. For instance, if a participant has joined or left a session.
Occurs when a viewer has pressed a button on the website.
Occurs when a viewer moves a joystick control on the website.