Show / Hide Table of Contents

    Class AudioVideoFramePlayer

    AudioVideoFramePlayer is responsible for streaming real time audio and video buffers. This frame player will handle audio and video sync from the audio and video buffer's timestamps

    Inheritance
    Object
    AudioVideoFramePlayer
    Implements
    IAudioVideoFramePlayer
    Inherited Members
    Object.ToString()
    Object.Equals(Object)
    Object.Equals(Object, Object)
    Object.ReferenceEquals(Object, Object)
    Object.GetHashCode()
    Object.GetType()
    Object.MemberwiseClone()
    Namespace: Microsoft.Skype.Bots.Media
    Assembly: Microsoft.Skype.Bots.Media.dll
    Syntax
    public class AudioVideoFramePlayer : IAudioVideoFramePlayer

    Constructors

    AudioVideoFramePlayer(AudioSocket, VideoSocket, AudioVideoFramePlayerSettings)

    Constructor for the audio video frame player.

    Declaration
    public AudioVideoFramePlayer(AudioSocket audioSocket, VideoSocket videoSocket, AudioVideoFramePlayerSettings audioVideoFramePlayerSettings)
    Parameters
    Type Name Description
    AudioSocket audioSocket
    VideoSocket videoSocket
    AudioVideoFramePlayerSettings audioVideoFramePlayerSettings

    Methods

    ClearAsync(Boolean, List<VideoFormat>)

    Clear the enqueued buffers. This will also invoke Dispose() on the buffers still in the queue.

    Declaration
    public Task ClearAsync(bool clearAudio = true, List<VideoFormat> videoFormats = null)
    Parameters
    Type Name Description
    Boolean clearAudio

    true will clear the audio buffers, Default value is set to true

    List<VideoFormat> videoFormats

    list of video formats to clear, default is null

    Returns
    Type Description
    Task

    EnqueueBuffersAsync(IList<AudioMediaBuffer>, IList<VideoMediaBuffer>)

    Enqueue the audio and video media buffers. Usage should be to enqueue the same audio and video length, if audio and video sockets are active.

    Declaration
    public Task EnqueueBuffersAsync(IList<AudioMediaBuffer> audioMediaBuffers, IList<VideoMediaBuffer> videoMediaBuffers)
    Parameters
    Type Name Description
    IList<AudioMediaBuffer> audioMediaBuffers
    IList<VideoMediaBuffer> videoMediaBuffers
    Returns
    Type Description
    Task

    ShutdownAsync()

    Shuts down the player and releases allocated resources

    Declaration
    public Task ShutdownAsync()
    Returns
    Type Description
    Task

    Events

    LowOnFrames

    Event to signal the player is low on frames

    Declaration
    public event EventHandler<LowOnFramesEventArgs> LowOnFrames
    Event Type
    Type Description
    EventHandler<LowOnFramesEventArgs>

    Implements

    IAudioVideoFramePlayer
    Back to top Copyright (c) Microsoft Corporation. All rights reserved.