- capture(GameClient) - Method in class com.mixer.interactive.resources.transaction.InteractiveTransaction
-
Asynchronously attempts to complete the Spark transaction on the Interactive service.
- capture(String) - Method in class com.mixer.interactive.services.TransactionServiceProvider
-
Attempt to complete a spark transaction from the participant that initiated the transaction.
- changeGroup(String) - Method in class com.mixer.interactive.resources.participant.InteractiveParticipant
-
Changes the group that the participant is a member of.
- changeGroup(InteractiveGroup) - Method in class com.mixer.interactive.resources.participant.InteractiveParticipant
-
Changes the group that the participant is a member of.
- claimNextPacketId() - Method in class com.mixer.interactive.services.RemoteProcedureCallServiceProvider
-
Claims and returns the next available packet id.
- claimNextPacketId() - Method in class com.mixer.interactive.ws.InteractiveWebSocketClient
-
Retrieves the next available packet id, then increments the internal counter to reflect that the previous id
has now been allocated.
- com.mixer.interactive - package com.mixer.interactive
-
Provides all interfaces and classes related to implementing the Interactive 2.0 specification.
- com.mixer.interactive.event - package com.mixer.interactive.event
-
Contains all of the classes associated with all Interactive events involving the Interactive service.
- com.mixer.interactive.event.connection - package com.mixer.interactive.event.connection
-
Contains all of the classes associated with websocket connection events involving the Interactive service.
- com.mixer.interactive.event.control - package com.mixer.interactive.event.control
-
Contains all of the classes associated with Interactive control events returned from the Interactive service.
- com.mixer.interactive.event.control.input - package com.mixer.interactive.event.control.input
-
Contains all of the classes associated with Interactive control input events returned from the Interactive service
- com.mixer.interactive.event.core - package com.mixer.interactive.event.core
-
Contains all of the classes associated with "core" Interactive events returned from the Interactive service.
- com.mixer.interactive.event.group - package com.mixer.interactive.event.group
-
Contains all of the classes associated with Interactive group events returned from the Interactive service.
- com.mixer.interactive.event.participant - package com.mixer.interactive.event.participant
-
Contains all of the classes associated with Interactive participant events returned from the Interactive service.
- com.mixer.interactive.event.scene - package com.mixer.interactive.event.scene
-
Contains all of the classes associated with Interactive scene events returned from the Interactive service.
- com.mixer.interactive.exception - package com.mixer.interactive.exception
-
Provides exception classes related to the Interactive service.
- com.mixer.interactive.gson - package com.mixer.interactive.gson
-
Contains custom type adapters for use in serializing/de-serializing Json using Gson.
- com.mixer.interactive.manager - package com.mixer.interactive.manager
-
Contains handlers for managing game client state.
- com.mixer.interactive.protocol - package com.mixer.interactive.protocol
-
Provides classes for implementing Interactive 2.0's network protocol.
- com.mixer.interactive.resources - package com.mixer.interactive.resources
-
Provides interfaces and classes relating to the Interactive service's different resource objects.
- com.mixer.interactive.resources.control - package com.mixer.interactive.resources.control
-
Provides interfaces and classes relating to Interactive controls.
- com.mixer.interactive.resources.core - package com.mixer.interactive.resources.core
-
Provides interfaces and classes relating to core Interactive resources.
- com.mixer.interactive.resources.group - package com.mixer.interactive.resources.group
-
Provides interfaces and classes relating to Interactive groups.
- com.mixer.interactive.resources.participant - package com.mixer.interactive.resources.participant
-
Provides interfaces and classes relating to Interactive participants
- com.mixer.interactive.resources.scene - package com.mixer.interactive.resources.scene
-
Provides interfaces and classes relating to Interactive scenes.
- com.mixer.interactive.resources.transaction - package com.mixer.interactive.resources.transaction
-
Provides interfaces and classes relating to Spark transactions involving the Interactive service.
- com.mixer.interactive.services - package com.mixer.interactive.services
-
Contains classes that act as service providers for the client.
- com.mixer.interactive.util - package com.mixer.interactive.util
-
Contains all classes and interfaces used in a utility capacity.
- com.mixer.interactive.util.compression - package com.mixer.interactive.util.compression
-
Contains all classes and interfaces related to the use of compression when communicating with the Interactive
service.
- com.mixer.interactive.ws - package com.mixer.interactive.ws
-
Contains all classes and interfaces related to the use of websockets to communicate with the Interactive service.
- compareTo(InteractiveControl) - Method in class com.mixer.interactive.resources.control.InteractiveControl
- compareTo(InteractiveControlPosition) - Method in class com.mixer.interactive.resources.control.InteractiveControlPosition
- compareTo(InteractiveGroup) - Method in class com.mixer.interactive.resources.group.InteractiveGroup
- compareTo(InteractiveParticipant) - Method in class com.mixer.interactive.resources.participant.InteractiveParticipant
- compareTo(InteractiveScene) - Method in class com.mixer.interactive.resources.scene.InteractiveScene
- CompressionScheme - Enum in com.mixer.interactive.resources.core
-
Enum containing all the compression schemes supported by the Interactive service and the client.
- CompressionUtil - Class in com.mixer.interactive.util.compression
-
Utility class to allow for generic compression/decompression of messages, depending on the client's current
CompressionScheme
.
- connect(String) - Method in class com.mixer.interactive.GameClient
-
Connects the game client to it's associated Interactive integration on the Interactive service, using either an
OAuth Bearer token or an xtoken to authenticate itself with the Interactive service.
- connect(String, String) - Method in class com.mixer.interactive.GameClient
-
Connects the game client to it's associated Interactive integration on the Interactive service, using either an
OAuth Bearer token or an xtoken to authenticate itself with the Interactive service and the appropriate share
code for the integration.
- ConnectionClosedEvent - Class in com.mixer.interactive.event.connection
-
Interactive event posted when a websocket connection to the Interactive service is closed.
- ConnectionClosedEvent(Number, URI, Number, String, boolean) - Constructor for class com.mixer.interactive.event.connection.ConnectionClosedEvent
-
Initializes a new ConnectionClosedEvent
.
- ConnectionErrorEvent - Class in com.mixer.interactive.event.connection
-
Interactive event posted when there is an error involving the websocket connection to the Interactive service.
- ConnectionErrorEvent(Number, URI, Exception) - Constructor for class com.mixer.interactive.event.connection.ConnectionErrorEvent
-
Initializes a new ConnectionErrorEvent
.
- ConnectionEstablishedEvent - Class in com.mixer.interactive.event.connection
-
Interactive event posted when a connection to the Interactive service has been opened and authenticated.
- ConnectionEstablishedEvent(Number, URI) - Constructor for class com.mixer.interactive.event.connection.ConnectionEstablishedEvent
-
Initializes a new ConnectionEstablishedEvent
.
- ConnectionEvent - Class in com.mixer.interactive.event.connection
-
The class InteractiveEvent
is the superclass of all classes relating to websocket connection events
involving the Interactive service and the GameClient
.
- ConnectionOpenEvent - Class in com.mixer.interactive.event.connection
-
Interactive event posted when a websocket connection to the Interactive service is opened.
- ConnectionOpenEvent(Number, URI, Number, String) - Constructor for class com.mixer.interactive.event.connection.ConnectionOpenEvent
-
Initializes a new ConnectionOpenEvent
.
- connectTo(String, URI) - Method in class com.mixer.interactive.GameClient
-
Connects the game client to it's associated Interactive integration on a specific Interactive service host,
using either an OAuth Bearer token or a xtoken to authenticate itself with the Interactive service.
- connectTo(String, String, URI) - Method in class com.mixer.interactive.GameClient
-
Connects the game client to it's associated Interactive integration on a specific Interactive service host,
using either an OAuth Bearer token or a xtoken to authenticate itself with the Interactive service and the
appropriate share code for the integration.
- CONTROL_SERVICE_PROVIDER - Static variable in class com.mixer.interactive.GameClient
-
- ControlCreateEvent - Class in com.mixer.interactive.event.control
-
Interactive event posted by the Interactive service when a control has been created.
- ControlCreateEvent(String, Collection<InteractiveControl>) - Constructor for class com.mixer.interactive.event.control.ControlCreateEvent
-
Initializes a new ControlCreateEvent
.
- ControlDeleteEvent - Class in com.mixer.interactive.event.control
-
Interactive event posted by the Interactive service when a control has been deleted.
- ControlDeleteEvent(String, Collection<String>) - Constructor for class com.mixer.interactive.event.control.ControlDeleteEvent
-
Initializes a new ControlDeleteEvent
.
- ControlDeleteEventAdapter - Class in com.mixer.interactive.gson
-
De-serializes a ControlDeleteEvent
.
- ControlDeleteEventAdapter() - Constructor for class com.mixer.interactive.gson.ControlDeleteEventAdapter
-
- ControlEvent - Class in com.mixer.interactive.event.control
-
The class ParticipantEvent
is the superclass of all classes relating to controls sent by the Interactive
service to the GameClient
.
- ControlEvent(String) - Constructor for class com.mixer.interactive.event.control.ControlEvent
-
Initializes a new ControlEvent
.
- ControlInputEvent - Class in com.mixer.interactive.event.control.input
-
The class ParticipantEvent
is the superclass of all classes relating to control input sent by the
Interactive service to the GameClient
.
- ControlInputEvent(String, String, InteractiveControlInput) - Constructor for class com.mixer.interactive.event.control.input.ControlInputEvent
-
Initializes a new ControlInputEvent
.
- ControlInputEventAdapter - Class in com.mixer.interactive.gson
-
De-serializes ControlInputEvents
into their appropriate subclasses.
- ControlInputEventAdapter() - Constructor for class com.mixer.interactive.gson.ControlInputEventAdapter
-
- ControlKeyDownEvent - Class in com.mixer.interactive.event.control.input
-
Interactive event posted by the Interactive service when a control has a keydown
input supplied.
- ControlKeyDownEvent(String, String, InteractiveControlInput) - Constructor for class com.mixer.interactive.event.control.input.ControlKeyDownEvent
-
Initializes a new ControlKeyDownInputEvent
.
- ControlKeyUpEvent - Class in com.mixer.interactive.event.control.input
-
Interactive event posted by the Interactive service when a control has a keyup
input supplied.
- ControlKeyUpEvent(String, String, InteractiveControlInput) - Constructor for class com.mixer.interactive.event.control.input.ControlKeyUpEvent
-
Initializes a new ControlKeyUpEvent
.
- ControlMouseDownInputEvent - Class in com.mixer.interactive.event.control.input
-
Interactive event posted by the Interactive service when a control has a mousedown
input supplied.
- ControlMouseDownInputEvent(String, String, InteractiveControlInput) - Constructor for class com.mixer.interactive.event.control.input.ControlMouseDownInputEvent
-
Initializes a new ControlMouseDownInputEvent
.
- ControlMouseUpInputEvent - Class in com.mixer.interactive.event.control.input
-
Interactive event posted by the Interactive service when a control has a mouseup
input supplied.
- ControlMouseUpInputEvent(String, String, InteractiveControlInput) - Constructor for class com.mixer.interactive.event.control.input.ControlMouseUpInputEvent
-
Initializes a new ControlMouseUpInputEvent
.
- ControlMoveInputEvent - Class in com.mixer.interactive.event.control.input
-
Interactive event posted by the Interactive service when a control has a move
input supplied.
- ControlMoveInputEvent(String, String, InteractiveControlInput) - Constructor for class com.mixer.interactive.event.control.input.ControlMoveInputEvent
-
Initializes a new ControlMoveInputEvent
.
- ControlServiceProvider - Class in com.mixer.interactive.services
-
Provides all functionality relating to making requests and interpreting replies from the Interactive service
regarding controls.
- ControlServiceProvider(GameClient) - Constructor for class com.mixer.interactive.services.ControlServiceProvider
-
Initializes a new ControlServiceProvider
.
- ControlUpdateEvent - Class in com.mixer.interactive.event.control
-
Interactive event posted by the Interactive service when a control has been updated.
- ControlUpdateEvent(String, Collection<InteractiveControl>) - Constructor for class com.mixer.interactive.event.control.ControlUpdateEvent
-
Initializes a new ControlUpdateEvent
.
- create(GameClient) - Method in class com.mixer.interactive.resources.control.InteractiveControl
-
Creates this
in the default scene on the Interactive service.
- create(GameClient) - Method in class com.mixer.interactive.resources.group.InteractiveGroup
-
Creates this
on the Interactive service.
- create(GameClient) - Method in interface com.mixer.interactive.resources.IInteractiveCreatable
-
Asynchronously creates this
on the Interactive service.
- create(GameClient) - Method in class com.mixer.interactive.resources.scene.InteractiveScene
-
Creates this
on the Interactive service.
- create(InteractiveControl...) - Method in class com.mixer.interactive.services.ControlServiceProvider
-
Creates one or more new controls.
- create(Collection<InteractiveControl>) - Method in class com.mixer.interactive.services.ControlServiceProvider
-
Creates one or more new controls.
- create(InteractiveGroup...) - Method in class com.mixer.interactive.services.GroupServiceProvider
-
Creates one or more new groups.
- create(Collection<InteractiveGroup>) - Method in class com.mixer.interactive.services.GroupServiceProvider
-
Creates one or more new groups.
- create(InteractiveScene...) - Method in class com.mixer.interactive.services.SceneServiceProvider
-
Creates one or more new scenes.
- create(Collection<InteractiveScene>) - Method in class com.mixer.interactive.services.SceneServiceProvider
-
Creates one or more new scenes.
- GameClient - Class in com.mixer.interactive
-
A GameClient
is used to connect to a Interactive integration that is hosted on the Interactive service.
- GameClient(Number) - Constructor for class com.mixer.interactive.GameClient
-
Initializes a new GameClient
.
- GameClient(Number, boolean) - Constructor for class com.mixer.interactive.GameClient
-
Initializes a new GameClient
.
- gameClient - Variable in class com.mixer.interactive.services.AbstractServiceProvider
-
GameClient
that owns this service provider
- get(Class<V>) - Method in class com.mixer.interactive.services.ServiceManager
-
Gets the service provider instance specified by the provided class.
- getActiveParticipants(long) - Method in class com.mixer.interactive.services.ParticipantServiceProvider
-
Retrieves all of the currently connected participants who have given input after the specified threshold time,
where the threshold is given as a UTC unix timestamp (in milliseconds), in ascending order by the time they last
gave input.
- getAddress() - Method in class com.mixer.interactive.resources.core.InteractiveHost
-
Returns the URI
address for the InteractiveHost
.
- getAllParticipants() - Method in class com.mixer.interactive.services.ParticipantServiceProvider
-
Retrieves all of the participants that are currently connected to the Interactive integration that this client
is connected to, in ascending order by the time they connected.
- getAngle() - Method in class com.mixer.interactive.resources.control.JoystickControl
-
Returns the location of the "halo" effect on screen.
- getButton() - Method in class com.mixer.interactive.event.control.input.ControlKeyDownEvent
-
Returns the keycode the participant used when interacting with the control.
- getButton() - Method in class com.mixer.interactive.event.control.input.ControlKeyUpEvent
-
Returns the keycode the participant used when interacting with the control.
- getButton() - Method in class com.mixer.interactive.event.control.input.ControlMouseDownInputEvent
-
Returns the keycode the participant used when interacting with the control.
- getButton() - Method in class com.mixer.interactive.event.control.input.ControlMouseUpInputEvent
-
Returns the keycode the participant used when interacting with the control.
- getCanvasSize() - Method in class com.mixer.interactive.resources.control.InteractiveControlPosition
-
Returns the InteractiveCanvasSize
for this control position.
- getCapacity() - Method in class com.mixer.interactive.resources.core.BandwidthThrottle
-
Returns the total bucket capacity.
- getCompressionScheme() - Method in class com.mixer.interactive.ws.InteractiveWebSocketClient
-
Retrieves the CompressionScheme
this InteractiveWebSocketClient
is using.
- getCompressionSchemes() - Method in class com.mixer.interactive.event.core.SetCompressionEvent
-
Returns a Set
of Strings
representing compression schemes.
- getConnectedAt() - Method in class com.mixer.interactive.resources.participant.InteractiveParticipant
-
Returns the UTC unix timestamp (in milliseconds) when the participant connected.
- getConnectionPromise() - Method in class com.mixer.interactive.ws.InteractiveWebSocketClient
-
Returns the CompletableFuture
promise holding the result of a connection attempt using this
websocket client.
- getControl(String) - Method in class com.mixer.interactive.resources.scene.InteractiveScene
-
Returns the InteractiveControl
matching by controlID
if this scene contains it,
null
otherwise.
- getControlID() - Method in class com.mixer.interactive.resources.control.InteractiveControl
-
Returns the unique identifier for the InteractiveControl
.
- getControlID() - Method in class com.mixer.interactive.resources.control.InteractiveControlInput
-
Returns the identifier for the control that received input.
- getControlIds() - Method in class com.mixer.interactive.event.control.ControlDeleteEvent
-
Returns the Set
of identifiers of InteractiveControls
included in the event.
- getControlInput() - Method in class com.mixer.interactive.event.control.input.ControlInputEvent
-
Returns the InteractiveControlInput
that was supplied by the InteractiveParticipant
- getControls() - Method in class com.mixer.interactive.event.control.ControlCreateEvent
-
Returns the Set
of InteractiveControls
included in the event.
- getControls() - Method in class com.mixer.interactive.event.control.ControlUpdateEvent
-
Returns the Set
of InteractiveControls
included in the event.
- getControls() - Method in class com.mixer.interactive.resources.scene.InteractiveScene
-
Returns all InteractiveControls
for this scene.
- getControls() - Method in class com.mixer.interactive.services.ControlServiceProvider
-
Retrieves all the controls for the Interactive integration.
- getCooldown() - Method in class com.mixer.interactive.resources.control.ButtonControl
-
Returns the UTC unix timestamp (in milliseconds) for when the cooldown for this ButtonControl
.
- getCost() - Method in class com.mixer.interactive.resources.control.ButtonControl
-
Returns the Spark cost for this ButtonControl
.
- getCumulativeBytes() - Method in class com.mixer.interactive.resources.core.InteractiveResourceMemoryStatistic
-
Returns the total number of bytes for the InteractiveResource
and all of the
InteractiveResources
that belong to it.
- getDiscard() - Method in class com.mixer.interactive.protocol.MethodPacket
-
Returns whether or not this request can be discarded (a reply is not required).
- getDrainRate() - Method in class com.mixer.interactive.resources.core.BandwidthThrottle
-
Returns the drain rate (in bytes per second) for the bucket.
- getError() - Method in exception com.mixer.interactive.exception.InteractiveReplyWithErrorException
-
Returns the InteractiveError
that was returned by the Interactive service.
- getError() - Method in class com.mixer.interactive.protocol.ReplyPacket
-
Returns the InteractiveError
returned from the Interactive service if there was an error.
- getErrorCode() - Method in exception com.mixer.interactive.exception.InteractiveConnectionException
-
Returns the error code returned when the websocket connection closed.
- getErrorCode() - Method in class com.mixer.interactive.protocol.InteractiveError
-
Returns the Interactive service error code.
- getErrorMessage() - Method in class com.mixer.interactive.protocol.InteractiveError
-
Returns the error message.
- getEvent() - Method in class com.mixer.interactive.resources.control.InteractiveControlInput
-
Returns the type of input event.
- getEventBus() - Method in class com.mixer.interactive.GameClient
-
Returns the EventBus
associated with the client.
- getException() - Method in class com.mixer.interactive.event.connection.ConnectionErrorEvent
-
Returns the Exception
returned from the InteractiveWebSocketClient
.
- getExecutorService() - Method in class com.mixer.interactive.GameClient
-
Returns the thread executor service used for creating CompletableFutures
.
- getGroup(String) - Method in class com.mixer.interactive.resources.scene.InteractiveScene
-
Returns the InteractiveGroup
matching by groupID
if this scene contains it,
null
otherwise.
- getGroupID() - Method in class com.mixer.interactive.event.group.GroupDeleteEvent
-
Returns the identifier for the InteractiveGroup
that has been deleted.
- getGroupID() - Method in class com.mixer.interactive.resources.group.InteractiveGroup
-
Returns the identifier for the InteractiveGroup
.
- getGroupID() - Method in class com.mixer.interactive.resources.participant.InteractiveParticipant
-
Returns the identifier for the InteractiveGroup
the participant is a member of.
- getGroups() - Method in class com.mixer.interactive.event.group.GroupCreateEvent
-
Returns a Set
of InteractiveGroups
that have been created.
- getGroups() - Method in class com.mixer.interactive.event.group.GroupUpdateEvent
-
Returns a Set
of InteractiveGroups
that have been updated.
- getGroups() - Method in class com.mixer.interactive.resources.scene.InteractiveScene
-
Returns all InteractiveGroups
for this scene.
- getGroups() - Method in class com.mixer.interactive.services.GroupServiceProvider
-
Retrieves all the groups connected to the Interactive integration.
- getHeight() - Method in class com.mixer.interactive.resources.control.InteractiveControlPosition
-
Returns the InteractiveControls
height for this control position.
- getInsertedPacketCount() - Method in class com.mixer.interactive.resources.core.ThrottleState
-
Returns a count of how many packets have been successfully sent.
- getIntensity() - Method in class com.mixer.interactive.resources.control.JoystickControl
-
Returns the opacity of the "halo" effect.
- getInteractiveHost() - Static method in class com.mixer.interactive.util.EndpointUtil
-
Returns the first InteractiveHost
returned from the API endpoint.
- getInteractiveHosts() - Static method in class com.mixer.interactive.util.EndpointUtil
-
Returns a List
of InteractiveHosts
returned from the API endpoint.
- getInteractiveHostURI() - Method in class com.mixer.interactive.event.connection.ConnectionEvent
-
Returns the URI
for the connected Interactive service host
- getKeyCode() - Method in class com.mixer.interactive.resources.control.ButtonControl
-
Returns the keyCode for this ButtonControl
.
- getKind() - Method in class com.mixer.interactive.resources.control.InteractiveControl
-
Returns the kind of control this InteractiveControl
is.
- getLastInputAt() - Method in class com.mixer.interactive.resources.participant.InteractiveParticipant
-
Returns the UTC unix timestamp (in milliseconds) since the participant last interacted with controls.
- getLastSequenceNumber() - Method in class com.mixer.interactive.ws.InteractiveWebSocketClient
-
Returns the sequence number that the socket has last seen from the service.
- getLevel() - Method in class com.mixer.interactive.resources.participant.InteractiveParticipant
-
Returns the participant's numeric (unsigned integer) Mixer level.
- getMemoryStats() - Method in class com.mixer.interactive.GameClient
-
Retrieves the current memory usage for the Interactive integration this client is connected to on the
Interactive service.
- getMeta() - Method in class com.mixer.interactive.resources.InteractiveResource
-
Returns the Json object holding the map of meta properties.
- getMethod() - Method in class com.mixer.interactive.protocol.MethodPacket
-
Retrieves the InteractiveMethod
to call on the Interactive service.
- getMethodName() - Method in class com.mixer.interactive.protocol.MethodPacket
-
Retrieves the method name to call on the Interactive service.
- getOwnBytes() - Method in class com.mixer.interactive.resources.core.InteractiveResourceMemoryStatistic
-
Returns the number of bytes used by the InteractiveResource
.
- getPacketID() - Method in class com.mixer.interactive.protocol.InteractivePacket
-
Returns the packet identifier.
- getParameters() - Method in class com.mixer.interactive.event.UndefinedInteractiveEvent
-
Returns a Map
containing raw parameters for the undefined event.
- getParticipantID() - Method in class com.mixer.interactive.event.control.input.ControlInputEvent
-
Returns the identifier for the InteractiveParticipant
that supplied the
InteractiveControlInput
- getParticipants() - Method in class com.mixer.interactive.event.participant.ParticipantEvent
-
Returns the Set
of InteractiveParticipants
included in the event.
- getPath() - Method in class com.mixer.interactive.protocol.InteractiveError
-
Returns the path to the property which caused the error.
- getPositionFor(String) - Method in class com.mixer.interactive.resources.control.InteractiveControl
-
Returns the InteractiveControlPosition
for the provided canvas size if there exists one,
null
otherwise.
- getPositionFor(InteractiveCanvasSize) - Method in class com.mixer.interactive.resources.control.InteractiveControl
-
Returns the InteractiveControlPosition
for the provided InteractiveCanvasSize
if
there exists one, null
otherwise.
- getPositions() - Method in class com.mixer.interactive.resources.control.InteractiveControl
-
Returns a Set
of all InteractiveControlPositions
for this
InteractiveControl
.
- getProgress() - Method in class com.mixer.interactive.resources.control.ButtonControl
-
Returns the value for the progress bar for this ButtonControl
.
- getProjectVersionID() - Method in class com.mixer.interactive.event.connection.ConnectionEvent
-
Returns the project version ID for the Interactive integration.
- getProjectVersionId() - Method in class com.mixer.interactive.GameClient
-
Returns the project version ID for the Interactive integration the client connects to.
- getRawInput() - Method in class com.mixer.interactive.resources.control.InteractiveControlInput
-
Returns the raw input parameters.
- getReason() - Method in exception com.mixer.interactive.exception.InteractiveConnectionException
-
Returns the reason returned when the websocket connection closed.
- getReassignGroupID() - Method in class com.mixer.interactive.event.group.GroupDeleteEvent
-
Returns the identifier for the InteractiveGroup
that InteractiveParticipants
have
been reassigned to.
- getReassignSceneID() - Method in class com.mixer.interactive.event.scene.SceneDeleteEvent
-
Returns the identifier for the InteractiveScene
that InteractiveGroups
have
been reassigned to.
- getRejectedPacketCount() - Method in class com.mixer.interactive.resources.core.ThrottleState
-
Returns a count of how many packets have been dropped (were not sent successfully) as a result of throttling
rules.
- getRequest() - Method in exception com.mixer.interactive.exception.InteractiveReplyWithErrorException
-
Returns the MethodPacket
representing the request that was sent by the client to the
Interactive service.
- getRequest() - Method in exception com.mixer.interactive.exception.InteractiveRequestNoReplyException
-
Returns the MethodPacket
representing the request that was sent by the client to the
Interactive service
- getRequestID() - Method in class com.mixer.interactive.event.InteractiveEvent
-
Returns the identifier for the packet the resulted in this event.
- getRequestParameters() - Method in class com.mixer.interactive.protocol.MethodPacket
-
Retrieves the parameters for the request.
- getResourceID() - Method in class com.mixer.interactive.resources.core.InteractiveResourceMemoryStatistic
-
Returns the identifier for the InteractiveResource
.
- getResourceMemoryStatistics() - Method in class com.mixer.interactive.event.core.MemoryWarningEvent
-
Returns a Set
of InteractiveResourceMemoryStatistics
.
- getResourceMemoryStats() - Method in class com.mixer.interactive.resources.core.InteractiveMemoryStatistic
-
Returns a Set
of InteractiveResourceMemoryStatistics
.
- getResourceMemoryStats() - Method in class com.mixer.interactive.resources.core.InteractiveResourceMemoryStatistic
-
Returns the Set
of InteractiveResourceMemoryStatistics
that belong to the
InteractiveResource
.
- getResult() - Method in class com.mixer.interactive.protocol.ReplyPacket
-
Returns the result that was returned by the Interactive service for the request.
- getResultAs(Type) - Method in class com.mixer.interactive.protocol.ReplyPacket
-
Returns the result of the request, parsed as an object of type T
.
- getResultAs(Class<T>) - Method in class com.mixer.interactive.protocol.ReplyPacket
-
Returns the result of the request, parsed as an object of type T
.
- getSampleRate() - Method in class com.mixer.interactive.resources.control.JoystickControl
-
Returns the sample rate for this JoystickControl
.
- getSceneID() - Method in class com.mixer.interactive.event.control.ControlEvent
-
Returns the identifier for the InteractiveScene
containing the InteractiveControls
.
- getSceneID() - Method in class com.mixer.interactive.event.scene.SceneDeleteEvent
-
Returns the identifier for the InteractiveScene
that has been deleted.
- getSceneID() - Method in class com.mixer.interactive.resources.control.InteractiveControl
-
Returns the unique identifier for the InteractiveScene
that contains this control.
- getSceneID() - Method in class com.mixer.interactive.resources.group.InteractiveGroup
-
Returns the identifier for the InteractiveScene
for the InteractiveGroup
.
- getSceneID() - Method in class com.mixer.interactive.resources.scene.InteractiveScene
-
Returns the unique identifier for this scene.
- getScenes() - Method in class com.mixer.interactive.event.scene.SceneCreateEvent
-
Returns a Set
of InteractiveScene
that have been created.
- getScenes() - Method in class com.mixer.interactive.event.scene.SceneUpdateEvent
-
Returns a Set
of InteractiveScenes
that have been updated.
- getScenes() - Method in class com.mixer.interactive.services.SceneServiceProvider
-
Retrieves all the scenes for the Interactive integration.
- getSequenceNumber() - Method in class com.mixer.interactive.protocol.InteractivePacket
-
Returns the packet sequence number.
- getSequenceNumber() - Method in class com.mixer.interactive.services.RemoteProcedureCallServiceProvider
-
Returns the last seen sequence number.
- getServiceManager() - Method in class com.mixer.interactive.GameClient
-
Returns the ServiceManager
associated with the client.
- getServiceProviders() - Method in class com.mixer.interactive.services.ServiceManager
-
Retrieves all service provider instances that are currently registered with this service provider as a
Set
.
- getSessionID() - Method in class com.mixer.interactive.resources.participant.InteractiveParticipant
-
Returns the unique string identifier for the participant in this session.
- getStateManager() - Method in class com.mixer.interactive.GameClient
-
Gets the StateManager for this game client.
- getStatusCode() - Method in class com.mixer.interactive.event.connection.ConnectionClosedEvent
-
Returns the HTTP status code returned when the connected was closed.
- getStatusCode() - Method in class com.mixer.interactive.event.connection.ConnectionOpenEvent
-
Returns the HTTP status code returned when the connected was closed.
- getStatusMessage() - Method in class com.mixer.interactive.event.connection.ConnectionClosedEvent
-
Returns the HTTP status message returned when the connection was closed.
- getStatusMessage() - Method in class com.mixer.interactive.event.connection.ConnectionOpenEvent
-
Returns the HTTP status message returned when the connection was closed.
- getText() - Method in class com.mixer.interactive.resources.control.ButtonControl
-
Returns the text displayed on the ButtonControl
.
- getThis() - Method in class com.mixer.interactive.resources.control.ButtonControl
-
Returns this
as an instance of the specified generic.
- getThis() - Method in class com.mixer.interactive.resources.control.JoystickControl
-
Returns this
as an instance of the specified generic.
- getThis() - Method in class com.mixer.interactive.resources.group.InteractiveGroup
-
Returns this
as an instance of the specified generic.
- getThis() - Method in class com.mixer.interactive.resources.InteractiveResource
-
Returns this
as an instance of the specified generic.
- getThis() - Method in class com.mixer.interactive.resources.participant.InteractiveParticipant
-
Returns this
as an instance of the specified generic.
- getThis() - Method in class com.mixer.interactive.resources.scene.InteractiveScene
-
Returns this
as an instance of the specified generic.
- getThrottleState() - Method in class com.mixer.interactive.GameClient
-
- getTime() - Method in class com.mixer.interactive.GameClient
-
Retrieves the current server time from the Interactive service, given as a milliseconds UTC unix timestamp.
- getTimeAdjustment() - Method in class com.mixer.interactive.manager.StateManager
-
Returns the most recently calculated amount of time, in milliseconds, to adjust cooldowns by to account for
network latency and differences in system time between the host running this game client and the Interactive
service.
- getTooltip() - Method in class com.mixer.interactive.resources.control.ButtonControl
-
Returns the tooltip text displayed when the participant hovers over the button.
- getTotalBytes() - Method in class com.mixer.interactive.event.core.MemoryWarningEvent
-
Returns the total number of bytes for the Interactive integration.
- getTotalBytes() - Method in class com.mixer.interactive.resources.core.InteractiveMemoryStatistic
-
Returns the total number of bytes for the Interactive integration.
- getTransaction() - Method in class com.mixer.interactive.event.control.input.ControlInputEvent
-
Returns the InteractiveTransaction
associated with this input event, if one exists.
- getTransactionID() - Method in class com.mixer.interactive.resources.transaction.InteractiveTransaction
-
Returns the identifier for the InteractiveTransaction
.
- getType() - Method in class com.mixer.interactive.protocol.InteractivePacket
-
Returns the packet type.
- getUsedBytes() - Method in class com.mixer.interactive.event.core.MemoryWarningEvent
-
Returns the number of bytes used by the Interactive integration.
- getUsedBytes() - Method in class com.mixer.interactive.resources.core.InteractiveMemoryStatistic
-
Returns the number of bytes used by the Interactive integration.
- getUserID() - Method in class com.mixer.interactive.resources.participant.InteractiveParticipant
-
Returns the user id (as an unsigned integer) for the participant on Mixer.
- getUsername() - Method in class com.mixer.interactive.resources.participant.InteractiveParticipant
-
Returns the participant's username on Mixer.
- getWaitingFuturesMap() - Method in class com.mixer.interactive.ws.InteractiveWebSocketClient
-
Retrieves the ConcurrentMap
of waiting CompletableFuture
promises and the IDs for the
packets that made the request.
- getWebSocketClient() - Method in class com.mixer.interactive.GameClient
-
Returns the web socket client that this game client uses to communicate with the Interactive service.
- getWidth() - Method in class com.mixer.interactive.resources.control.InteractiveControlPosition
-
Returns the InteractiveControls
width for this control position.
- getX() - Method in class com.mixer.interactive.event.control.input.ControlMoveInputEvent
-
Returns the X position of the joystick control.
- getX() - Method in class com.mixer.interactive.resources.control.InteractiveControlPosition
-
Returns the InteractiveControls
X position for this control position.
- getY() - Method in class com.mixer.interactive.event.control.input.ControlMoveInputEvent
-
Returns the Y position of the joystick control.
- getY() - Method in class com.mixer.interactive.resources.control.InteractiveControlPosition
-
Returns the InteractiveControls
Y position for this control position.
- GROUP_SERVICE_PROVIDER - Static variable in class com.mixer.interactive.GameClient
-
- GroupCreateEvent - Class in com.mixer.interactive.event.group
-
Interactive event posted by the Interactive service when a new group has been created.
- GroupCreateEvent(Collection<InteractiveGroup>) - Constructor for class com.mixer.interactive.event.group.GroupCreateEvent
-
Initializes a new GroupCreateEvent
.
- GroupDeleteEvent - Class in com.mixer.interactive.event.group
-
Interactive event posted by the Interactive service when a group has been deleted.
- GroupDeleteEvent(String, String) - Constructor for class com.mixer.interactive.event.group.GroupDeleteEvent
-
Initializes a new GroupDeleteEvent
.
- GroupEvent - Class in com.mixer.interactive.event.group
-
The class GroupEvent
is the superclass of all classes relating to groups sent by the Interactive service
to the GameClient
.
- GroupEvent() - Constructor for class com.mixer.interactive.event.group.GroupEvent
-
- GroupServiceProvider - Class in com.mixer.interactive.services
-
Provides all functionality relating to making requests and interpreting replies from the Interactive service
regarding groups.
- GroupServiceProvider(GameClient) - Constructor for class com.mixer.interactive.services.GroupServiceProvider
-
Initializes a new GroupServiceProvider
.
- GroupUpdateEvent - Class in com.mixer.interactive.event.group
-
Interactive event posted by the Interactive service when a group has been updated.
- GroupUpdateEvent(Collection<InteractiveGroup>) - Constructor for class com.mixer.interactive.event.group.GroupUpdateEvent
-
Initializes a new GroupUpdateEvent
.
- GSON - Static variable in class com.mixer.interactive.GameClient
-
Gson
singleton used for serialization/deserialization.
- ICoder - Interface in com.mixer.interactive.util.compression
-
The interface ICoder
defines methods relating to the compression/decompression of messages exchanged
between the client and the Interactive service.
- IInteractiveCreatable - Interface in com.mixer.interactive.resources
-
The interface IInteractiveCreatable
defines methods for creating a resource on the Interactive service.
- IInteractiveDeletable - Interface in com.mixer.interactive.resources
-
The interface IInteractiveCreatable
defines methods for deleting a resource on the Interactive service.
- IInteractiveUpdatable - Interface in com.mixer.interactive.resources
-
The interface IInteractiveCreatable
defines methods for updating a resource on the Interactive service.
- input - Variable in class com.mixer.interactive.event.control.input.ControlInputEvent
-
The InteractiveControlInput
that was supplied by the InteractiveParticipant
- InteractiveCanvasSize - Enum in com.mixer.interactive.resources.control
-
Enum containing all the available control canvas sizes offered by the Interactive service.
- InteractiveCanvasSizeAdapter - Class in com.mixer.interactive.gson
-
Serializes/de-serializes InteractiveCanvasSize
from/to their appropriate enum value.
- InteractiveCanvasSizeAdapter() - Constructor for class com.mixer.interactive.gson.InteractiveCanvasSizeAdapter
-
- InteractiveConnectionException - Exception in com.mixer.interactive.exception
-
Checked exception thrown when a websocket connection to the Mixer Interactive service fails to connect.
- InteractiveConnectionException(String) - Constructor for exception com.mixer.interactive.exception.InteractiveConnectionException
-
Initializes a new InteractiveConnectionException
.
- InteractiveConnectionException(URI, int, String) - Constructor for exception com.mixer.interactive.exception.InteractiveConnectionException
-
Initializes a new InteractiveConnectionException
.
- InteractiveControl<T extends InteractiveResource<T>> - Class in com.mixer.interactive.resources.control
-
The abstract class InteractiveControl
is the superclass for all controls on the Interactive service.
- InteractiveControlAdapter - Class in com.mixer.interactive.gson
-
De-serializes InteractiveControls
into their appropriate subclasses.
- InteractiveControlAdapter() - Constructor for class com.mixer.interactive.gson.InteractiveControlAdapter
-
- InteractiveControlInput - Class in com.mixer.interactive.resources.control
-
A InteractiveControlInput
represents an polymorphic input event (such as a mousedown
event
for a button control, or a move
event for a joystick control).
- InteractiveControlInput(String, String, Map<String, JsonElement>) - Constructor for class com.mixer.interactive.resources.control.InteractiveControlInput
-
Initializes a new InteractiveControlInput
.
- InteractiveControlInputAdapter - Class in com.mixer.interactive.gson
-
De-serializes InteractiveControlInput
.
- InteractiveControlInputAdapter() - Constructor for class com.mixer.interactive.gson.InteractiveControlInputAdapter
-
- InteractiveControlPosition - Class in com.mixer.interactive.resources.control
-
A InteractiveControlPosition
represents the position and size of the asociated control on the specified
control canvas area.
- InteractiveControlPosition(InteractiveCanvasSize) - Constructor for class com.mixer.interactive.resources.control.InteractiveControlPosition
-
Initializes a new InteractiveControlPosition
with default values.
- InteractiveControlPosition(String, int, int, int, int) - Constructor for class com.mixer.interactive.resources.control.InteractiveControlPosition
-
Initializes a new InteractiveControlPosition
.
- InteractiveControlPosition(InteractiveCanvasSize, int, int, int, int) - Constructor for class com.mixer.interactive.resources.control.InteractiveControlPosition
-
Initializes a new InteractiveControlPosition
.
- InteractiveControlType - Enum in com.mixer.interactive.resources.control
-
Enum containing all the types of controls supported by the Interactive service.
- InteractiveControlTypeAdapter - Class in com.mixer.interactive.gson
-
Serializes/de-serializes InteractiveControlType
from/to their appropriate enum value.
- InteractiveControlTypeAdapter() - Constructor for class com.mixer.interactive.gson.InteractiveControlTypeAdapter
-
- InteractiveCoreEvent - Class in com.mixer.interactive.event.core
-
The class InteractiveCoreEvent
is the superclass of all classes relating to all core events sent by the
Interactive service to the GameClient
.
- InteractiveCoreEvent() - Constructor for class com.mixer.interactive.event.core.InteractiveCoreEvent
-
- InteractiveError - Class in com.mixer.interactive.protocol
-
A InteractiveError
represents the error object that could be returned as part of a
ReplyPacket
.
- InteractiveError(int, String, String) - Constructor for class com.mixer.interactive.protocol.InteractiveError
-
Initializes a new InteractiveError
.
- InteractiveEvent - Class in com.mixer.interactive.event
-
The abstract class InteractiveEvent
is the superclass of all classes relating to events sent
from the Interactive service to the GameClient
.
- InteractiveEvent() - Constructor for class com.mixer.interactive.event.InteractiveEvent
-
- InteractiveException - Exception in com.mixer.interactive.exception
-
The class InteractiveException
is the superclass of all Exception
classes relating to
interactions with the Interactive service.
- InteractiveException() - Constructor for exception com.mixer.interactive.exception.InteractiveException
-
Initializes a new InteractiveException
.
- InteractiveException(String) - Constructor for exception com.mixer.interactive.exception.InteractiveException
-
Initializes a new InteractiveException
.
- InteractiveGroup - Class in com.mixer.interactive.resources.group
-
A InteractiveGroup
represents a group on the Interactive service.
- InteractiveGroup(String) - Constructor for class com.mixer.interactive.resources.group.InteractiveGroup
-
Initializes a new InteractiveGroup
.
- InteractiveGroup(String, String) - Constructor for class com.mixer.interactive.resources.group.InteractiveGroup
-
Initializes a new InteractiveGroup
.
- InteractiveHost - Class in com.mixer.interactive.resources.core
-
A InteractiveHost
represents a host running on the Interactive service that a client can connect to.
- InteractiveHost(URI) - Constructor for class com.mixer.interactive.resources.core.InteractiveHost
-
Initializes a new InteractiveHost
.
- InteractiveMemoryStatistic - Class in com.mixer.interactive.resources.core
-
A InteractiveMemoryStatistic
represents a point in time snapshot of the current memory usage for the
Interactive integration the client is currently connected to.
- InteractiveMemoryStatistic(int, int, Collection<InteractiveResourceMemoryStatistic>) - Constructor for class com.mixer.interactive.resources.core.InteractiveMemoryStatistic
-
Initializes a new InteractiveMemoryStatistic
.
- InteractiveMethod - Enum in com.mixer.interactive.protocol
-
Enum containing all the methods supported by the Interactive service.
- InteractiveNoHostsFoundException - Exception in com.mixer.interactive.exception
-
Checked exception thrown when no Interactive hosts are found when querying the host discovery endpoint.
- InteractiveNoHostsFoundException() - Constructor for exception com.mixer.interactive.exception.InteractiveNoHostsFoundException
-
Initializes a new InteractiveNoHostsFoundException
- InteractivePacket - Class in com.mixer.interactive.protocol
-
The class InteractivePacket
is the superclass of all packet classes representing messages to and from
the Interactive service.
- InteractivePacketAdapter - Class in com.mixer.interactive.gson
-
De-serializes InteractivePackets
into their appropriate subclasses.
- InteractivePacketAdapter() - Constructor for class com.mixer.interactive.gson.InteractivePacketAdapter
-
- InteractiveParticipant - Class in com.mixer.interactive.resources.participant
-
A InteractiveParticipant
represents a participant using the Interactive service.
- InteractiveParticipant(String, Integer, String, Integer, Long, Long, Boolean, String) - Constructor for class com.mixer.interactive.resources.participant.InteractiveParticipant
-
Initializes a new InteractiveParticipant
.
- InteractiveReplyWithErrorException - Exception in com.mixer.interactive.exception
-
Checked exception thrown when an InteractiveError
is returned in the reply sent by the Interactive
service in response to a method request.
- InteractiveReplyWithErrorException(MethodPacket, InteractiveError) - Constructor for exception com.mixer.interactive.exception.InteractiveReplyWithErrorException
-
Initializes a new InteractiveReplyWithErrorException
.
- InteractiveRequestNoReplyException - Exception in com.mixer.interactive.exception
-
Checked exception thrown when no reply to a method request is received from the Interactive service before the
request timed out.
- InteractiveRequestNoReplyException(MethodPacket) - Constructor for exception com.mixer.interactive.exception.InteractiveRequestNoReplyException
-
Initializes a new InteractiveRequestNoReplyException
.
- InteractiveRequestNoReplyException(String, MethodPacket) - Constructor for exception com.mixer.interactive.exception.InteractiveRequestNoReplyException
-
Initializes a new InteractiveRequestNoReplyException
.
- InteractiveResource<T extends InteractiveResource<T>> - Class in com.mixer.interactive.resources
-
The abstract class InteractiveResource
is the superclass of all classes representing resources
on the Interactive service.
- InteractiveResource() - Constructor for class com.mixer.interactive.resources.InteractiveResource
-
- InteractiveResourceMemoryStatistic - Class in com.mixer.interactive.resources.core
-
A InteractiveResourceMemoryStatistic
represents a point in time snapshot of the current memory usage for
a specific resource in the Interactive integration the client is currently connected to.
- InteractiveResourceMemoryStatistic(String, int, int, Collection<InteractiveResourceMemoryStatistic>) - Constructor for class com.mixer.interactive.resources.core.InteractiveResourceMemoryStatistic
-
Initializes a new InteractiveResourceMemoryStatistic
.
- InteractiveScene - Class in com.mixer.interactive.resources.scene
-
A InteractiveScene
represents a scene resource on the Interactive service.
- InteractiveScene(String) - Constructor for class com.mixer.interactive.resources.scene.InteractiveScene
-
Initializes a new InteractiveScene
.
- InteractiveScene(String, Collection<InteractiveGroup>, Collection<InteractiveControl>) - Constructor for class com.mixer.interactive.resources.scene.InteractiveScene
-
Initializes a new InteractiveScene
.
- InteractiveSceneAdapter - Class in com.mixer.interactive.gson
-
De-serializes a InteractiveScene
.
- InteractiveSceneAdapter() - Constructor for class com.mixer.interactive.gson.InteractiveSceneAdapter
-
- InteractiveTransaction - Class in com.mixer.interactive.resources.transaction
-
A InteractiveTransaction
represents a Spark transaction on the Interactive service.
- InteractiveTransaction(String) - Constructor for class com.mixer.interactive.resources.transaction.InteractiveTransaction
-
Initializes a new InteractiveTransaction
.
- InteractiveWebSocketClient - Class in com.mixer.interactive.ws
-
A websocket client designed specifically for use with the Interactive service.
- InteractiveWebSocketClient(GameClient, URI, String, Number) - Constructor for class com.mixer.interactive.ws.InteractiveWebSocketClient
-
Initialize a new InteractiveWebSocketClient
.
- InteractiveWebSocketClient(GameClient, URI, String, Number, String) - Constructor for class com.mixer.interactive.ws.InteractiveWebSocketClient
-
Initialize a new InteractiveWebSocketClient
.
- isConnected() - Method in class com.mixer.interactive.GameClient
-
Returns true
if this client is currently connected to the Interactive service,
false
otherwise.
- isDefault() - Method in class com.mixer.interactive.resources.group.InteractiveGroup
-
Returns true
if this is the default group, false
otherwise.
- isDefault() - Method in class com.mixer.interactive.resources.scene.InteractiveScene
-
Returns true
if this is the default scene, false
otherwise.
- isDisabled() - Method in class com.mixer.interactive.resources.control.InteractiveControl
-
Returns true
if this InteractiveControlType
is disabled, false
otherwise
- isDisabled() - Method in class com.mixer.interactive.resources.participant.InteractiveParticipant
-
Returns whether or not a the participants’s input as been disabled
- isReady() - Method in class com.mixer.interactive.event.core.ReadyEvent
-
Returns true
if Interactive integration is ready for interaction, false
otherwise.
- SCENE_SERVICE_PROVIDER - Static variable in class com.mixer.interactive.GameClient
-
- SceneCreateEvent - Class in com.mixer.interactive.event.scene
-
Interactive event posted by the Interactive service when a new scene has been created.
- SceneCreateEvent(Collection<InteractiveScene>) - Constructor for class com.mixer.interactive.event.scene.SceneCreateEvent
-
Initializes a new SceneCreateEvent
.
- SceneDeleteEvent - Class in com.mixer.interactive.event.scene
-
Interactive event posted by the Interactive service when a scene has been deleted.
- SceneDeleteEvent(String, String) - Constructor for class com.mixer.interactive.event.scene.SceneDeleteEvent
-
Initializes a new SceneDeleteEvent
.
- SceneEvent - Class in com.mixer.interactive.event.scene
-
The class ParticipantEvent
is the superclass of all classes relating to scenes sent by the Interactive
service to the GameClient
.
- SceneEvent() - Constructor for class com.mixer.interactive.event.scene.SceneEvent
-
- SceneServiceProvider - Class in com.mixer.interactive.services
-
Provides all functionality relating to making requests and interpreting replies from the Interactive service
regarding scenes.
- SceneServiceProvider(GameClient) - Constructor for class com.mixer.interactive.services.SceneServiceProvider
-
Initializes a new SceneServiceProvider
.
- SceneUpdateEvent - Class in com.mixer.interactive.event.scene
-
Interactive event posted by the Interactive service when a scene has been updated.
- SceneUpdateEvent(Collection<InteractiveScene>) - Constructor for class com.mixer.interactive.event.scene.SceneUpdateEvent
-
Initializes a new SceneUpdateEvent
.
- send(MethodPacket) - Method in class com.mixer.interactive.services.RemoteProcedureCallServiceProvider
-
Sends a request to the Interactive service, returning the reply.
- send(MethodPacket, long, TimeUnit) - Method in class com.mixer.interactive.services.RemoteProcedureCallServiceProvider
-
Prepares and sends a request to the Interactive service, returning the parsed reply.
- send(Collection<MethodPacket>) - Method in class com.mixer.interactive.services.RemoteProcedureCallServiceProvider
-
Prepares and sends one or many requests to the Interactive service, returning a list of replies that are in
the same order as the input collection.
- send(Collection<MethodPacket>, long, TimeUnit) - Method in class com.mixer.interactive.services.RemoteProcedureCallServiceProvider
-
Prepares and sends one or many requests to the Interactive service, returning a list of replies that are in
the same order as the input collection.
- send(String) - Method in class com.mixer.interactive.ws.InteractiveWebSocketClient
- serialize(InteractiveCanvasSize, Type, JsonSerializationContext) - Method in class com.mixer.interactive.gson.InteractiveCanvasSizeAdapter
- serialize(InteractiveControl, Type, JsonSerializationContext) - Method in class com.mixer.interactive.gson.InteractiveControlAdapter
- serialize(InteractiveControlType, Type, JsonSerializationContext) - Method in class com.mixer.interactive.gson.InteractiveControlTypeAdapter
- ServiceManager<T extends AbstractServiceProvider> - Class in com.mixer.interactive.services
-
A ServiceManager
contains instances of service providers that perform some function within the client.
- ServiceManager(GameClient) - Constructor for class com.mixer.interactive.services.ServiceManager
-
Initializes a new ServiceManager
.
- setAngle(Number) - Method in class com.mixer.interactive.resources.control.JoystickControl
-
Sets the location of the "halo" effect on screen.
- setBandwidthThrottle(Map<InteractiveMethod, BandwidthThrottle>) - Method in class com.mixer.interactive.GameClient
-
Sets up throttling for certain server-to-client method calls, such as
InteractiveMethod.GIVE_INPUT
,
which could become problematic in very high-traffic scenarios.
- setCompression(CompressionScheme...) - Method in class com.mixer.interactive.GameClient
-
Changes the compression algorithm the client uses to encode/decode messages to/from the Interactive
service.
- setCompression(String...) - Method in class com.mixer.interactive.GameClient
-
Changes the compression algorithm the client uses to encode/decode messages to/from the Interactive
service.
- setCompression(Collection<String>) - Method in class com.mixer.interactive.GameClient
-
Changes the compression algorithm the client uses to encode/decode messages to/from the Interactive
service.
- SetCompressionEvent - Class in com.mixer.interactive.event.core
-
Interactive event posted by the Interactive service when the compression algorithm used to encode messages.
- SetCompressionEvent(Collection<String>) - Constructor for class com.mixer.interactive.event.core.SetCompressionEvent
-
Initializes a new SetCompressionEvent
.
- setCompressionScheme(String) - Method in class com.mixer.interactive.ws.InteractiveWebSocketClient
-
Sets the CompressionScheme
that this InteractiveWebSocketClient
will use.
- setCompressionScheme(CompressionScheme) - Method in class com.mixer.interactive.ws.InteractiveWebSocketClient
-
Sets the CompressionScheme
that this InteractiveWebSocketClient
will use.
- setConnectionPromise(CompletableFuture<Boolean>) - Method in class com.mixer.interactive.ws.InteractiveWebSocketClient
-
Sets the CompletableFuture
promise holding the result of a connection attempt using this
websocket client.
- setCooldown(Number) - Method in class com.mixer.interactive.resources.control.ButtonControl
-
Sets the UTC unix timestamp (in milliseconds) for when the cooldown for this ButtonControl
expires.
- setCooldown(Instant) - Method in class com.mixer.interactive.resources.control.ButtonControl
-
Sets the UTC unix timestamp (in milliseconds) for when the cooldown for this ButtonControl
expires.
- setCost(Integer) - Method in class com.mixer.interactive.resources.control.ButtonControl
-
Sets the Spark cost for this ButtonControl
.
- setDisabled(Boolean) - Method in class com.mixer.interactive.resources.control.InteractiveControl
-
Sets the disabled state for this InteractiveControlType
.
- setDisabled(Boolean) - Method in class com.mixer.interactive.resources.participant.InteractiveParticipant
-
Sets a participant's ability to provide input.
- setHeight(int) - Method in class com.mixer.interactive.resources.control.InteractiveControlPosition
-
Sets the InteractiveControls
height for this control position.
- setIntensity(Number) - Method in class com.mixer.interactive.resources.control.JoystickControl
-
Sets the opacity of the "halo" effect.
- setKeyCode(Integer) - Method in class com.mixer.interactive.resources.control.ButtonControl
-
Sets the keyCode for this ButtonControl
.
- setMeta(JsonObject) - Method in class com.mixer.interactive.resources.InteractiveResource
-
Sets the Json object holding the map of meta properties.
- setPositions(Collection<InteractiveControlPosition>) - Method in class com.mixer.interactive.resources.control.InteractiveControl
-
Sets the InteractiveControlPositions
for this InteractiveControl
.
- setPositions(InteractiveControlPosition...) - Method in class com.mixer.interactive.resources.control.InteractiveControl
-
Sets the InteractiveControlPositions
for this InteractiveControl
.
- setProgress(Float) - Method in class com.mixer.interactive.resources.control.ButtonControl
-
Sets the value for the progress bar for this ButtonControl
.
- setRequestID(int) - Method in class com.mixer.interactive.event.InteractiveEvent
-
Sets the identifier for the packet the resulted in this event.
- setSampleRate(Integer) - Method in class com.mixer.interactive.resources.control.JoystickControl
-
Sets the sample rate for this JoystickControl
.
- setScene(String) - Method in class com.mixer.interactive.resources.group.InteractiveGroup
-
Sets the InteractiveScene
for the InteractiveGroup
.
- setScene(InteractiveScene) - Method in class com.mixer.interactive.resources.group.InteractiveGroup
-
Sets the InteractiveScene
for the InteractiveGroup
.
- setSequenceNumber(int) - Method in class com.mixer.interactive.protocol.InteractivePacket
-
Sets the packet sequence number.
- setText(String) - Method in class com.mixer.interactive.resources.control.ButtonControl
-
Sets the text to be displayed on the ButtonControl
.
- setTooltip(String) - Method in class com.mixer.interactive.resources.control.ButtonControl
-
Sets the tooltip text to be displayed when the participant hovers over the ButtonControl
.
- setWidth(int) - Method in class com.mixer.interactive.resources.control.InteractiveControlPosition
-
Sets the InteractiveControls
width for this control position.
- setX(int) - Method in class com.mixer.interactive.resources.control.InteractiveControlPosition
-
Sets the InteractiveControls
X position for this control position.
- setY(int) - Method in class com.mixer.interactive.resources.control.InteractiveControlPosition
-
Sets the InteractiveControls
Y position for this control position.
- StateManager - Class in com.mixer.interactive.manager
-
Manages collections of cached objects (scenes/controls/groups) for the game client associated with this.
- StateManager(GameClient) - Constructor for class com.mixer.interactive.manager.StateManager
-
Constructs a new StateManager
- syncIfEqual(Collection<?>) - Method in class com.mixer.interactive.resources.control.ButtonControl
-
Iterates through a Collection
of Objects.
- syncIfEqual(Collection<?>) - Method in class com.mixer.interactive.resources.control.JoystickControl
-
Iterates through a Collection
of Objects.
- syncIfEqual(Collection<?>) - Method in class com.mixer.interactive.resources.group.InteractiveGroup
-
Iterates through a Collection
of Objects.
- syncIfEqual(Collection<?>) - Method in class com.mixer.interactive.resources.InteractiveResource
-
Iterates through a Collection
of Objects.
- syncIfEqual(Collection<?>) - Method in class com.mixer.interactive.resources.participant.InteractiveParticipant
-
Iterates through a Collection
of Objects.
- syncIfEqual(Collection<?>) - Method in class com.mixer.interactive.resources.scene.InteractiveScene
-
Iterates through a Collection
of Objects.