Our new developer documentation is now available. Please check it out!
Classes
Warning
Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.
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 |
|---|---|
| OdinHandler | |
| MicrophoneReader | Handles microphone input data and sends input to ODIN |
| PlaybackComponent | Handles the Playback for received ODIN audio data. |
| OdinBanner |
Utility Classes
Many of these classes are used internally or you rarely need to work with these.
| Component | Description |
|---|---|
| NativeBindings | C# bindings for the native ODIN runtime |
| 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 |
| OdinMediaConfig | ODIN audio stream configuration |
| OdinRoomConfig | Audio processing configuration of an ODIN room |
| Utility | |
| MediaCollection | Internal collection of available media streams |
| MediaStream | Base stream |
| MicrophoneStream | Representation of a write only audio stream |
| PlaybackStream | Representation of a read only audio stream |
| OdinClient | Client Wrapper for ODIN ffi OdinLibrary |
| OdinDefaults | ODIN default configuration |
| Peer | Client/Remote peer |
| PeerCollection | Intern peer dictionary |
| ConnectionStateChangedEventArgs | Arguments for ConnectionStateChanged events in the current room |
| MediaActiveStateChangedEventArgs | Arguments for MediaActiveStateChanged events in the current room |
| MediaAddedEventArgs | Arguments for MediaAdded events in the current room |
| MediaRemovedEventArgs | Arguments for MediaRemoved events in the current room |
| MessageReceivedEventArgs | Arguments for MessageReceived events in the current room |
| PeerJoinedEventArgs | Arguments for PeerJoined events in the current room |
| PeerLeftEventArgs | Arguments for PeerLeft events in the current room |
| PeerUserDataChangedEventArgs | Arguments for PeerUserDataChanged events in the current room |
| Room | Main Room |
| RoomCollection | Intern room dictionary |
| RoomConfig | A set of values that are used when creating Rooms |
| RoomJoinEventArgs | Arguments for RoomJoin events right before the room is joined |
| RoomJoinedEventArgs | Arguments for RoomJoined events when the room was joined successfully |
| RoomLeaveEventArgs | Arguments for RoomLeave events right before the room handle is destroyed |
| RoomLeftEventArgs | Arguments for RoomLeft events when the room handle was destroyed |
| RoomUserDataChangedEventArgs | Arguments for RoomUserDataChanged events in the current room |
| UserData | Odin UserData helper for marshal byte arrays |
| 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) |
| 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) |
| 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) |
| 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) |
| 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) |
| 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) |
| 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) |
| 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) |
| RoomJoinProxy | This class provides the base functionality for ODIN SDK UnityEvents. A persistent callback that can be saved with the Scene. |
| RoomJoinedProxy | This class provides the base functionality for ODIN SDK UnityEvents. A persistent callback that can be saved with the Scene. |
| RoomLeaveProxy | This class provides the base functionality for ODIN SDK UnityEvents. A persistent callback that can be saved with the Scene. |
| RoomLeftProxy | This class provides the base functionality for ODIN SDK UnityEvents. A persistent callback that can be saved with the Scene. |
| 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) |
| UnityCreatedMediaObject | |
| UnityDeleteMediaObject | Unity Inspector event wrapper (UnityEvent) |
| OdinEditorConfig | UnityEditor UI component for instance config of Odin |