Share via

video module

  • Reference
Package:
@microsoft/teams-js

Namespace to video extensibility of the SDK.

Interfaces

VideoFrame

Represents a video frame.
VideoFrameConfig

Video frame configuration supplied to Teams to customize the generated video frame parameters, like format.

Type Aliases

VideoEffectCallBack

Video effect change call back function definition
VideoFrameCallback

Video frame call back function definition

Enums

EffectChangeType

Video effect change type enum
VideoFrameFormat

Video frame format enum, currently only support NV12

Functions

notifySelectedVideoEffectChanged(EffectChangeType, undefined | string)

video extension should call this to notify Teams Client current selected effect parameter changed. If it's pre-meeting, Teams client will call videoEffectCallback immediately then use the videoEffect. * in-meeting scenario, we will call videoEffectCallback when apply button clicked.
registerForVideoEffect(VideoEffectCallBack)

Register the video effect callback, Teams client uses this to notify the video extension the new video effect will by applied.
registerForVideoFrame(VideoFrameCallback, VideoFrameConfig)

Register to read the video frames in Permissions section.

Function Details

notifySelectedVideoEffectChanged(EffectChangeType, undefined | string)

video extension should call this to notify Teams Client current selected effect parameter changed. If it's pre-meeting, Teams client will call videoEffectCallback immediately then use the videoEffect. * in-meeting scenario, we will call videoEffectCallback when apply button clicked.

function notifySelectedVideoEffectChanged(effectChangeType: EffectChangeType, effectId: undefined | string)

Parameters

effectChangeType

@microsoft/teams-js.@microsoft.teams-js.video.EffectChangeType

The effect change type.

effectId

undefined | string

Newly selected effect id.

registerForVideoEffect(VideoEffectCallBack)

Register the video effect callback, Teams client uses this to notify the video extension the new video effect will by applied.

function registerForVideoEffect(callback: VideoEffectCallBack)

Parameters

callback

@microsoft/teams-js.@microsoft.teams-js.video.VideoEffectCallBack

registerForVideoFrame(VideoFrameCallback, VideoFrameConfig)

Register to read the video frames in Permissions section.

function registerForVideoFrame(frameCallback: VideoFrameCallback, config: VideoFrameConfig)

Parameters

frameCallback

@microsoft/teams-js.@microsoft.teams-js.video.VideoFrameCallback

config

@microsoft/teams-js.@microsoft.teams-js.video.VideoFrameConfig