Show / Hide Table of Contents

    Class MediaSession

    Inheritance
    Object
    MediaSession
    Implements
    ILocalMediaSession
    IMediaSession
    IDisposable
    Namespace: Microsoft.Graph.Communications.Calls.Media
    Assembly: Microsoft.Graph.Communications.Calls.Media.dll
    Syntax
    public class MediaSession : ObjectRootDisposable, ILocalMediaSession, IMediaSession, IDisposable

    Constructors

    MediaSession(IGraphLogger, Guid, AudioSocketSettings, VideoSocketSettings, VideoSocketSettings, DataSocketSettings)

    Initializes a new instance of the MediaSession class.

    Declaration
    public MediaSession(IGraphLogger logger, Guid mediaSessionId, AudioSocketSettings audioSocketSettings, VideoSocketSettings videoSocketSettings, VideoSocketSettings vbssSocketSettings = null, DataSocketSettings dataSocketSettings = null)
    Parameters
    Type Name Description
    IGraphLogger logger

    The logger.

    Guid mediaSessionId

    The media session id.

    AudioSocketSettings audioSocketSettings

    The audio socket settings.

    VideoSocketSettings videoSocketSettings

    The video socket settings.

    VideoSocketSettings vbssSocketSettings

    The video based screen sharing socket settings.

    DataSocketSettings dataSocketSettings

    The data socket settings.

    Exceptions
    Type Condition
    ArgumentException

    When no media session id or no valid socket settings have been specified.

    MediaSession(IGraphLogger, Guid, AudioSocketSettings, IEnumerable<VideoSocketSettings>, VideoSocketSettings, DataSocketSettings)

    Initializes a new instance of the MediaSession class.

    Declaration
    public MediaSession(IGraphLogger logger, Guid mediaSessionId, AudioSocketSettings audioSocketSettings, IEnumerable<VideoSocketSettings> videoSocketSettings = null, VideoSocketSettings vbssSocketSettings = null, DataSocketSettings dataSocketSettings = null)
    Parameters
    Type Name Description
    IGraphLogger logger

    The logger.

    Guid mediaSessionId

    The media session id.

    AudioSocketSettings audioSocketSettings

    The audio socket settings.

    IEnumerable<VideoSocketSettings> videoSocketSettings

    The video socket settings.

    VideoSocketSettings vbssSocketSettings

    The video based screen sharing socket settings.

    DataSocketSettings dataSocketSettings

    The data socket settings.

    Exceptions
    Type Condition
    ArgumentException

    When no media session id or no valid socket settings have been specified.

    Properties

    AudioSocket

    Gets the audio socket associated with this media session.

    Declaration
    public IAudioSocket AudioSocket { get; }
    Property Value
    Type Description
    IAudioSocket

    DataSocket

    Gets the data socket associated with this media session.

    Declaration
    public IDataSocket DataSocket { get; }
    Property Value
    Type Description
    IDataSocket

    MediaSessionId

    Declaration
    public Guid MediaSessionId { get; }
    Property Value
    Type Description
    Guid

    Modalities

    Declaration
    public Modality[] Modalities { get; }
    Property Value
    Type Description
    Modality[]

    VbssSocket

    Gets the VBSS socket associated with this media session.

    Declaration
    public IVideoSocket VbssSocket { get; }
    Property Value
    Type Description
    IVideoSocket

    VideoSocket

    Gets the video socket associated with this media session. If current media session contains multiple sockets, this will return the first one in the list.

    Declaration
    public IVideoSocket VideoSocket { get; }
    Property Value
    Type Description
    IVideoSocket

    VideoSockets

    Gets the list of video socket associated with this media session.

    Declaration
    public IReadOnlyList<IVideoSocket> VideoSockets { get; }
    Property Value
    Type Description
    IReadOnlyList<IVideoSocket>

    Methods

    Dispose(Boolean)

    Declaration
    protected override void Dispose(bool disposing)
    Parameters
    Type Name Description
    Boolean disposing

    GetMediaConfiguration()

    Declaration
    public JObject GetMediaConfiguration()
    Returns
    Type Description
    Newtonsoft.Json.Linq.JObject

    Implements

    ILocalMediaSession
    IMediaSession
    System.IDisposable
    Back to top Copyright (c) Microsoft Corporation. All rights reserved.