CallFeatureStreamState interface

Package:

@azure/communication-react

State only version of <xref:%40azure%2Fcommunication-calling%23CallFeatureStream>. Represents call feature stream state.

Extends

RemoteVideoStreamState

Properties

feature

The name of the call feature stream.

Inherited Properties

id	Proxy of <xref:%40azure%2Fcommunication-calling%23RemoteVideoStream.id>.
isAvailable	Proxy of <xref:%40azure%2Fcommunication-calling%23RemoteVideoStream.isAvailable>.
isReceiving	Proxy of <xref:%40azure%2Fcommunication-calling%23RemoteVideoStream.isReceiving>.
mediaStreamType	Proxy of <xref:%40azure%2Fcommunication-calling%23RemoteVideoStream.mediaStreamType>.
streamSize	Proxy of <xref:%40azure%2Fcommunication-calling%23RemoteVideoStream.size>.
view	<xref:VideoStreamRendererView> that is managed by createView/disposeView in StatefulCallClient API. This can be undefined if the stream has not yet been rendered and defined after createView creates the view.

Property Details

feature

The name of the call feature stream.

feature?: "togetherMode"

Property Value

"togetherMode"

Inherited Property Details

id

Proxy of <xref:%40azure%2Fcommunication-calling%23RemoteVideoStream.id>.

id: number

Property Value

number

Inherited From RemoteVideoStreamState.id

isAvailable

Proxy of <xref:%40azure%2Fcommunication-calling%23RemoteVideoStream.isAvailable>.

isAvailable: boolean

Property Value

boolean

Inherited From RemoteVideoStreamState.isAvailable

isReceiving

Proxy of <xref:%40azure%2Fcommunication-calling%23RemoteVideoStream.isReceiving>.

public isReceiving: boolean

Property Value

boolean

Inherited From RemoteVideoStreamState.isReceiving

mediaStreamType

Proxy of <xref:%40azure%2Fcommunication-calling%23RemoteVideoStream.mediaStreamType>.

mediaStreamType: MediaStreamType

Property Value

MediaStreamType

Inherited From RemoteVideoStreamState.mediaStreamType

streamSize

Proxy of <xref:%40azure%2Fcommunication-calling%23RemoteVideoStream.size>.

streamSize?: { height: number, width: number }

Property Value

{ height: number, width: number }

Inherited From RemoteVideoStreamState.streamSize

view

<xref:VideoStreamRendererView> that is managed by createView/disposeView in StatefulCallClient API. This can be undefined if the stream has not yet been rendered and defined after createView creates the view.

view?: VideoStreamRendererViewState

Property Value

VideoStreamRendererViewState

Inherited From RemoteVideoStreamState.view