Developer Documentation

OdinHandler.GetPlaybackComponents

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.

public PlaybackComponent[] GetPlaybackComponents()
public PlaybackComponent[] GetPlaybackComponents(string roomId)
public PlaybackComponent[] GetPlaybackComponents(ulong peerId)
public PlaybackComponent[] GetPlaybackComponents(long mediaStreamId)

Gets all Audio across all rooms

Info

Simply uses FindObjectsOfType PlaybackComponent A PlaybackComponent always have RoomName, PeerId and MediaId properties.

Parameters

NameTypeDescription
roomIdStringRoom identifier e.g name or token
peerIdUInt64peer ID
mediaStreamIdInt64media handle ID

Returns

TypeDescription
PlaybackComponent[]The array of objects found matching the type PlaybackComponent.

Variants

GetPlaybackComponents()

public PlaybackComponent[] GetPlaybackComponents()

Gets all Audio across all rooms

Warning

Simply uses FindObjectsOfType PlaybackComponent A PlaybackComponent always have RoomName, PeerId and MediaId properties.

Returns

TypeDescription
PlaybackComponent[]The array of objects found matching the type PlaybackComponent.

GetPlaybackComponents(roomId)

public PlaybackComponent[] GetPlaybackComponents(string roomId)

Gets all Audio filtered by room

Warning

A PlaybackComponent always have RoomName, PeerId and MediaId properties.

Parameters

NameTypeDescription
roomIdStringRoom identifier e.g name or token

Returns

TypeDescription
PlaybackComponent[]The filtered array of objects found matching the type PlaybackComponent.

GetPlaybackComponents(peerId)

public PlaybackComponent[] GetPlaybackComponents(ulong peerId)

Gets all Audio across rooms filtered by peer

Warning

A PlaybackComponent always have RoomName, PeerId and MediaId properties.

Parameters

NameTypeDescription
peerIdUInt64peer ID

Returns

TypeDescription
PlaybackComponent[]The filtered array of objects found matching the type PlaybackComponent.

GetPlaybackComponents(mediaStreamId)

public PlaybackComponent[] GetPlaybackComponents(long mediaStreamId)

Gets all Audio across rooms filtered by media

Warning

A PlaybackComponent always have RoomName, PeerId and MediaId properties.

Parameters

NameTypeDescription
mediaStreamIdInt64media handle ID

Returns

TypeDescription
PlaybackComponent[]The filtered array of objects found matching the type PlaybackComponent.