Class AudioStreamReceiver

AudioStreamReceiver is a component that receives audio streams and plays them through a specified AudioSource.

Inheritance

object

Object

Component

Behaviour

MonoBehaviour

StreamReceiverBase

AudioStreamReceiver

Implements

IStreamReceiver

Inherited Members

StreamReceiverBase.Transceiver

StreamReceiverBase.OnStartedStream

StreamReceiverBase.OnStoppedStream

StreamReceiverBase.Track

StreamReceiverBase.isPlaying

StreamReceiverBase.SetTransceiver(string, RTCRtpTransceiver)

StreamReceiverBase.OnDestroy()

MonoBehaviour.IsInvoking()

MonoBehaviour.CancelInvoke()

MonoBehaviour.Invoke(string, float)

MonoBehaviour.InvokeRepeating(string, float, float)

MonoBehaviour.CancelInvoke(string)

MonoBehaviour.IsInvoking(string)

MonoBehaviour.StartCoroutine(string)

MonoBehaviour.StartCoroutine(string, object)

MonoBehaviour.StartCoroutine(IEnumerator)

MonoBehaviour.StopCoroutine(IEnumerator)

MonoBehaviour.StopCoroutine(Coroutine)

MonoBehaviour.StopCoroutine(string)

MonoBehaviour.StopAllCoroutines()

MonoBehaviour.print(object)

MonoBehaviour.useGUILayout

MonoBehaviour.runInEditMode

Behaviour.enabled

Behaviour.isActiveAndEnabled

Component.GetComponent(Type)

Component.GetComponent<T>()

Component.TryGetComponent(Type, out Component)

Component.TryGetComponent<T>(out T)

Component.GetComponent(string)

Component.GetComponentInChildren(Type, bool)

Component.GetComponentInChildren(Type)

Component.GetComponentInChildren<T>(bool)

Component.GetComponentInChildren<T>()

Component.GetComponentsInChildren(Type, bool)

Component.GetComponentsInChildren(Type)

Component.GetComponentsInChildren<T>(bool)

Component.GetComponentsInChildren<T>(bool, List<T>)

Component.GetComponentsInChildren<T>()

Component.GetComponentsInChildren<T>(List<T>)

Component.GetComponentInParent(Type, bool)

Component.GetComponentInParent(Type)

Component.GetComponentInParent<T>(bool)

Component.GetComponentInParent<T>()

Component.GetComponentsInParent(Type, bool)

Component.GetComponentsInParent(Type)

Component.GetComponentsInParent<T>(bool)

Component.GetComponentsInParent<T>(bool, List<T>)

Component.GetComponentsInParent<T>()

Component.GetComponents(Type)

Component.GetComponents(Type, List<Component>)

Component.GetComponents<T>(List<T>)

Component.GetComponents<T>()

Component.CompareTag(string)

Component.SendMessageUpwards(string, object, SendMessageOptions)

Component.SendMessageUpwards(string, object)

Component.SendMessageUpwards(string)

Component.SendMessageUpwards(string, SendMessageOptions)

Component.SendMessage(string, object)

Component.SendMessage(string)

Component.SendMessage(string, object, SendMessageOptions)

Component.SendMessage(string, SendMessageOptions)

Component.BroadcastMessage(string, object, SendMessageOptions)

Component.BroadcastMessage(string, object)

Component.BroadcastMessage(string)

Component.BroadcastMessage(string, SendMessageOptions)

Component.transform

Component.gameObject

Component.tag

Object.GetInstanceID()

Object.GetHashCode()

Object.Equals(object)

Object.Instantiate(Object, Vector3, Quaternion)

Object.Instantiate(Object, Vector3, Quaternion, Transform)

Object.Instantiate(Object)

Object.Instantiate(Object, Transform)

Object.Instantiate(Object, Transform, bool)

Object.Instantiate<T>(T)

Object.Instantiate<T>(T, Vector3, Quaternion)

Object.Instantiate<T>(T, Vector3, Quaternion, Transform)

Object.Instantiate<T>(T, Transform)

Object.Instantiate<T>(T, Transform, bool)

Object.Destroy(Object, float)

Object.Destroy(Object)

Object.DestroyImmediate(Object, bool)

Object.DestroyImmediate(Object)

Object.FindObjectsOfType(Type)

Object.FindObjectsOfType(Type, bool)

Object.FindObjectsByType(Type, FindObjectsSortMode)

Object.FindObjectsByType(Type, FindObjectsInactive, FindObjectsSortMode)

Object.DontDestroyOnLoad(Object)

Object.FindObjectsOfType<T>()

Object.FindObjectsByType<T>(FindObjectsSortMode)

Object.FindObjectsOfType<T>(bool)

Object.FindObjectsByType<T>(FindObjectsInactive, FindObjectsSortMode)

Object.FindObjectOfType<T>()

Object.FindObjectOfType<T>(bool)

Object.FindFirstObjectByType<T>()

Object.FindAnyObjectByType<T>()

Object.FindFirstObjectByType<T>(FindObjectsInactive)

Object.FindAnyObjectByType<T>(FindObjectsInactive)

Object.FindObjectOfType(Type)

Object.FindFirstObjectByType(Type)

Object.FindAnyObjectByType(Type)

Object.FindObjectOfType(Type, bool)

Object.FindFirstObjectByType(Type, FindObjectsInactive)

Object.FindAnyObjectByType(Type, FindObjectsInactive)

Object.ToString()

Object.name

Object.hideFlags

Namespace: Unity.RenderStreaming

Assembly: Unity.RenderStreaming.dll

Syntax

[AddComponentMenu("Render Streaming/Audio Stream Receiver")]
public class AudioStreamReceiver : StreamReceiverBase, IStreamReceiver

Fields

OnUpdateReceiveAudioSource

Event triggered when the received audio source is updated.

Declaration

public AudioStreamReceiver.OnUpdateReceiveAudioSourceHandler OnUpdateReceiveAudioSource

Field Value

Type	Description
AudioStreamReceiver.OnUpdateReceiveAudioSourceHandler

See Also

AudioCodecInfo

Properties

codec

Gets the codec information for the audio stream.

Declaration

public AudioCodecInfo codec { get; }

Property Value

Type	Description
AudioCodecInfo

See Also

AudioCodecInfo

targetAudioSource

Gets or sets the target AudioSource where the received audio will be played.

Declaration

public AudioSource targetAudioSource { get; set; }

Property Value

Type	Description
AudioSource

See Also

AudioCodecInfo

Methods

GetAvailableCodecs()

Declaration

public static IEnumerable<AudioCodecInfo> GetAvailableCodecs()

Returns

Type	Description
IEnumerable<AudioCodecInfo>

See Also

AudioCodecInfo

SetCodec(AudioCodecInfo)

Sets the codec for the audio stream.

Declaration

public void SetCodec(AudioCodecInfo codec)

Parameters

Type	Name	Description
AudioCodecInfo	codec	The codec information to set.

Examples

var codec = AudioStreamReceiver.GetAvailableCodecs().FirstOrDefault(x => x.mimeType.Contains("opus"));
audioStreamReceiver.SetCodec(codec);

Exceptions

Type	Condition
InvalidOperationException	Thrown if the transceiver is streaming or the track has ended.

See Also

AudioCodecInfo

Implements

IStreamReceiver

See Also

AudioCodecInfo