Classes
The Unity SDK consists of these classes:
Unity Components
You typically interact with these components directly in the Unity Editor. Check out the manual on how to use these components in the Unity editor.
| Component | Description |
|---|---|
| OdinApmComponent | AudioProcessingModule component for Media This class provides configuration for the native implemented audio processing. The supported processor/filter are applicable to Media which must be set. |
| OdinAudioReader | Handles audioclip input data and sends input to ODIN This convenient class gathers input audio data from Unity to pass the data with OdinAudioReader event to other components. |
| OdinBanner | |
| OdinConnection | Wrapper class of Odin connections This convenient class provides dispatching of events to Unity with passthrough |
| OdinCustomEffectUnityComponentBase | Custom base component for Media This convenient class provides effect template with a passthrough of custom userdata on a callback. The abstract representation of a base custom effect is to simplify implementation of Audio as a Unity component. (see other predefined custom effects) |
| OdinMedia | Wrapper class of Odin for Unity (require AudioSource) This convenient class provides predefined helper functions to cover for a default usecases where the voice chat needs to work with AudioSource, AudioClip, AudioMixer, … Default Unity GameObject altering functions:
|
| OdinMicrophoneReader | Handles microphone input data and sends input to ODIN This convenient class gathers input audio data from Unity managed Microphone to pass the data with OdinMicrophoneReader event to other components. |
| OdinPeer | Wrapper class of Odin for Unity This convenient class provides dispatching of events to Unity with passthrough
|
| OdinRoom | Wrapper class of Room for Unity. This convenient class provides dispatching of events to Unity with passthrough
|
| OdinVadComponent | VoiceActivity component for Media This class provides configuration for the native implemented voice detection. Supports speech recognition and/or a volume threshold. |
Utility Classes
Many of these classes are used internally or you rarely need to work with these.
| Component | Description |
|---|---|
| ApmEffect | VoiceActivity effect for Odin |
| ArrayEnumerable | |
| ConnectionStateChangedEventArgs | Arguments for ConnectionStateChanged events in the current room |
| ConnectionStateChangedProxy | This class provides the base functionality for UnityEvents based Room. A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent) |
| CustomEffect | Custom effect for Odin callbacks |
| DatagramEventArgs | Arguments for datagram events |
| DatagramProxy | This class provides the base functionality for UnityEvents based Room. A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent) |
| MapEnumerable | |
| MediaActiveStateChangedEventArgs | Arguments for MediaActiveStateChanged events in the current room |
| MediaActiveStateChangedProxy | This class provides the base functionality for UnityEvents based Room. A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent) |
| MediaAddedEventArgs | Arguments for MediaAdded events in the current room |
| MediaAddedProxy | This class provides the base functionality for UnityEvents based Room. A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent) |
| MediaDecoder | Odin Playback Media |
| MediaEncoder | Odin Capture Media |
| MediaPipeline | Odin audio pipeline |
| MediaRemovedEventArgs | Arguments for MediaRemoved events in the current room |
| MediaRemovedProxy | This class provides the base functionality for UnityEvents based Room. A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent) |
| MediaRpcProperties | arbitrary media data |
| MessagePackReaderException | |
| MessageReceivedEventArgs | Arguments for MessageReceived events in the current room |
| MessageReceivedProxy | This class provides the base functionality for UnityEvents based Room. A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent) |
| MsgPackToken | https://github.com/msgpack/msgpack/blob/master/spec.md |
| MsgPackWriter | Rudimentary Msgpack implementation that will be used for sending RPC to the server. |
| NativeBindings | C# bindings for the native ODIN runtime |
| Notification | Msgpack RPC spec https://github.com/msgpack-rpc/msgpack-rpc/blob/master/spec.md |
| OdinAudioData | |
| OdinAudioMediaCallbackMarshal | |
| OdinAudioMediaMarshal | |
| OdinCallbackAudioData | |
| OdinClient | Client Wrapper for ODIN ffi OdinNative.Core.OdinLibrary.NativeMethods |
| OdinColliderFilterComponent | Custom filter by collider component for Media This class is a effect in the odin audio pipline to mute audio based on GameObject collisions in Unity space. The effect can help to trigger specific audio packets quickly without the adjustment of Server-side positions. |
| OdinConnectionPoolHandle | |
| OdinDecoderHandle | |
| OdinDefaults | ODIN default configuration |
| OdinEncoderHandle | |
| OdinException | Exception type for the native ODIN runtime |
| OdinLibrary | Main lib entry class |
| OdinLibraryParameters | A set of values that are used when initializing the native ODIN runtime |
| OdinMediaData | |
| OdinMuteAudioComponent | Custom mute audio component for Media This class is a effect in the odin audio pipline to mute based on the OdinMuteAudioComponent flag. The intention is to provide a convenient way with Unity Editor UI of Marshal a 1-byte signed integer bool for a specific audio packet in the current pipline. |
| OdinPipelineHandle | |
| OdinRoomHandle | |
| OdinTerrainFilterComponent | Custom filter by terrain component for Media This class is a effect in the odin audio pipline to mute audio based on location of a GameObject relative to a terrain type in Unity space. Note that the default implementation is Unity specific on a 2D calculation with X, Z and is not useful in all occlusions. |
| OdinTokenGeneratorHandle | |
| OdinVolumeBoostComponent | Custom volume scale component for Media This class is a effect in the odin audio pipline to scale each sample individually in the buffer. |
| OdinVolumeComponent | Custom volume component for Media. Recommend the use of AudioSource.volume or AudioMixer/AudioMixerGroup instead This class is a effect in the odin audio pipline to change audio buffers by amplify the volume level. |
| PeerEntity | Client/Remote peer |
| PeerJoinedEventArgs | Arguments for PeerJoined events in the current room |
| PeerJoinedProxy | This class provides the base functionality for UnityEvents based Room. A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent) |
| PeerLeftEventArgs | Arguments for PeerLeft events in the current room |
| PeerLeftProxy | This class provides the base functionality for UnityEvents based Room. A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent) |
| PeerUserDataChangedEventArgs | Arguments for PeerUserDataChanged events in the current room |
| PeerUserDataChangedProxy | This class provides the base functionality for UnityEvents based Room. A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent) |
| PiplineEffect | |
| Request | Msgpack RPC spec https://github.com/msgpack-rpc/msgpack-rpc/blob/master/spec.md |
| Response | Msgpack RPC spec https://github.com/msgpack-rpc/msgpack-rpc/blob/master/spec.md |
| Room | Main Room |
| RoomCollection | Intern room dictionary |
| RoomJoinEventArgs | Arguments for RoomJoin events right before the room is joined |
| RoomJoinProxy | This class provides the base functionality for ODIN SDK UnityEvents. A persistent callback that can be saved with the Scene. |
| RoomJoinedEventArgs | Arguments for RoomJoined events when the room was joined successfully |
| RoomJoinedProxy | This class provides the base functionality for ODIN SDK UnityEvents. A persistent callback that can be saved with the Scene. |
| RoomLeaveEventArgs | Arguments for RoomLeave events right before the room handle is destroyed |
| RoomLeaveProxy | This class provides the base functionality for ODIN SDK UnityEvents. A persistent callback that can be saved with the Scene. |
| RoomLeftEventArgs | Arguments for RoomLeft events when the room handle was destroyed |
| RoomLeftProxy | This class provides the base functionality for ODIN SDK UnityEvents. A persistent callback that can be saved with the Scene. |
| RoomUserDataChangedEventArgs | Arguments for RoomUserDataChanged events in the current room |
| RoomUserDataChangedProxy | This class provides the base functionality for UnityEvents based Room. A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent) |
| RpcEventArgs | Arguments for rpc events |
| RpcFormat | Msgpack RPC spec https://github.com/msgpack-rpc/msgpack-rpc/blob/master/spec.md |
| RpcProxy | This class provides the base functionality for UnityEvents based Room. A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent) |
| RpcResult | Result of send rpc responses |
| UnityAudioData | |
| UnityCreatedMediaObject | |
| UnityDeleteMediaObject | Unity Inspector event wrapper (UnityEvent) |
| UserData | Odin UserData helper for marshal byte arrays |
| Utility | |
| VadEffect | VoiceActivity effect for Odin |