Facebook
Twitter
Pinterest
Tumblr
GitHub
RSS
  • DEV Home
  • Documentation
  • Reference
  • Download
Search Results for

    Show / Hide Table of Contents

    Class SessionInfo

    Class SessionInfo

    Inheritance
    System.Object
    SessionInfo
    Implements
    System.IDisposable
    Namespace: MediaBrowser.Controller.Session
    Assembly: MediaBrowser.Controller.dll
    Syntax
    public sealed class SessionInfo : IDisposable

    Constructors

    SessionInfo()

    Declaration
    public SessionInfo()

    SessionInfo(ISessionManager, ILogger)

    Declaration
    public SessionInfo(ISessionManager sessionManager, ILogger logger)
    Parameters
    Type Name Description
    ISessionManager sessionManager
    ILogger logger

    Properties

    AdditionalUsers

    Declaration
    public SessionUserInfo[] AdditionalUsers { get; set; }
    Property Value
    Type Description
    SessionUserInfo[]

    AppIconUrl

    Gets or sets the application icon URL.

    Declaration
    public string AppIconUrl { get; }
    Property Value
    Type Description
    System.String

    The application icon URL.

    ApplicationVersion

    Gets or sets the application version.

    Declaration
    public string ApplicationVersion { get; set; }
    Property Value
    Type Description
    System.String

    The application version.

    Capabilities

    Declaration
    [IgnoreDataMember]
    public ClientCapabilities Capabilities { get; set; }
    Property Value
    Type Description
    ClientCapabilities

    Client

    Gets or sets the type of the client.

    Declaration
    public string Client { get; set; }
    Property Value
    Type Description
    System.String

    The type of the client.

    DeviceId

    Gets or sets the device id.

    Declaration
    public string DeviceId { get; set; }
    Property Value
    Type Description
    System.String

    The device id.

    DeviceName

    Gets or sets the name of the device.

    Declaration
    public string DeviceName { get; set; }
    Property Value
    Type Description
    System.String

    The name of the device.

    DeviceType

    Declaration
    public string DeviceType { get; set; }
    Property Value
    Type Description
    System.String

    FullNowPlayingItem

    Declaration
    [IgnoreDataMember]
    public BaseItem FullNowPlayingItem { get; }
    Property Value
    Type Description
    BaseItem

    HasCustomDeviceName

    Declaration
    [IgnoreDataMember]
    public bool HasCustomDeviceName { get; set; }
    Property Value
    Type Description
    System.Boolean

    HasUser

    Declaration
    [IgnoreDataMember]
    public bool HasUser { get; }
    Property Value
    Type Description
    System.Boolean

    Id

    Gets or sets the id.

    Declaration
    public string Id { get; set; }
    Property Value
    Type Description
    System.String

    The id.

    InternalDeviceId

    Declaration
    public long InternalDeviceId { get; set; }
    Property Value
    Type Description
    System.Int64

    IsActive

    Gets a value indicating whether this instance is active.

    Declaration
    [IgnoreDataMember]
    public bool IsActive { get; }
    Property Value
    Type Description
    System.Boolean

    true if this instance is active; otherwise, false.

    LastActivityDate

    Gets or sets the last activity date.

    Declaration
    public DateTimeOffset LastActivityDate { get; set; }
    Property Value
    Type Description
    System.DateTimeOffset

    The last activity date.

    NowPlayingItem

    Gets or sets the now playing item.

    Declaration
    public BaseItemDto NowPlayingItem { get; }
    Property Value
    Type Description
    BaseItemDto

    The now playing item.

    NowPlayingQueue

    Declaration
    [IgnoreDataMember]
    public QueueItem[] NowPlayingQueue { get; set; }
    Property Value
    Type Description
    QueueItem[]

    PlayableMediaTypes

    Gets or sets the playable media types.

    Declaration
    public string[] PlayableMediaTypes { get; }
    Property Value
    Type Description
    System.String[]

    The playable media types.

    PlaylistIndex

    Declaration
    public int PlaylistIndex { get; set; }
    Property Value
    Type Description
    System.Int32

    PlaylistItemId

    Declaration
    public string PlaylistItemId { get; set; }
    Property Value
    Type Description
    System.String

    PlaylistLength

    Declaration
    public int PlaylistLength { get; set; }
    Property Value
    Type Description
    System.Int32

    PlayState

    Declaration
    public PlayerStateInfo PlayState { get; }
    Property Value
    Type Description
    PlayerStateInfo

    Protocol

    Declaration
    public string Protocol { get; set; }
    Property Value
    Type Description
    System.String

    RemoteEndPoint

    Gets or sets the remote end point.

    Declaration
    public IPAddress RemoteEndPoint { get; set; }
    Property Value
    Type Description
    System.Net.IPAddress

    The remote end point.

    ServerId

    Declaration
    public string ServerId { get; set; }
    Property Value
    Type Description
    System.String

    SessionControllers

    Gets or sets the session controller.

    Declaration
    [IgnoreDataMember]
    public ISessionController[] SessionControllers { get; set; }
    Property Value
    Type Description
    ISessionController[]

    The session controller.

    SupportedCommands

    Gets or sets the supported commands.

    Declaration
    public string[] SupportedCommands { get; }
    Property Value
    Type Description
    System.String[]

    The supported commands.

    SupportsRemoteControl

    Declaration
    public bool SupportsRemoteControl { get; }
    Property Value
    Type Description
    System.Boolean

    TranscodingInfo

    Declaration
    public TranscodingInfo TranscodingInfo { get; }
    Property Value
    Type Description
    TranscodingInfo

    UserId

    Gets or sets the user id.

    Declaration
    public string UserId { get; set; }
    Property Value
    Type Description
    System.String

    The user id.

    UserInternalId

    Declaration
    [IgnoreDataMember]
    public long UserInternalId { get; set; }
    Property Value
    Type Description
    System.Int64

    UserName

    Gets or sets the username.

    Declaration
    public string UserName { get; set; }
    Property Value
    Type Description
    System.String

    The username.

    UserPrimaryImageTag

    Declaration
    public string UserPrimaryImageTag { get; set; }
    Property Value
    Type Description
    System.String

    Methods

    AddController(ISessionController)

    Declaration
    public void AddController(ISessionController controller)
    Parameters
    Type Name Description
    ISessionController controller

    ContainsUser(Int64)

    Declaration
    public bool ContainsUser(long userId)
    Parameters
    Type Name Description
    System.Int64 userId
    Returns
    Type Description
    System.Boolean

    Dispose()

    Declaration
    public void Dispose()

    EnsureController<T>(Func<SessionInfo, ISessionController>)

    Declaration
    public Tuple<ISessionController, bool> EnsureController<T>(Func<SessionInfo, ISessionController> factory)
    Parameters
    Type Name Description
    System.Func<SessionInfo, ISessionController> factory
    Returns
    Type Description
    System.Tuple<ISessionController, System.Boolean>
    Type Parameters
    Name Description
    T

    GetOrAddPlaySessionInfo(PlaybackProgressInfo)

    Declaration
    public PlaySessionInfo GetOrAddPlaySessionInfo(PlaybackProgressInfo info)
    Parameters
    Type Name Description
    PlaybackProgressInfo info
    Returns
    Type Description
    PlaySessionInfo

    GetPlaySessionInfo(String)

    Declaration
    public PlaySessionInfo GetPlaySessionInfo(string playSessionId)
    Parameters
    Type Name Description
    System.String playSessionId
    Returns
    Type Description
    PlaySessionInfo

    IsControllableByUser(User, Boolean)

    Declaration
    public bool IsControllableByUser(User user, bool allowAllForAdmins)
    Parameters
    Type Name Description
    User user
    System.Boolean allowAllForAdmins
    Returns
    Type Description
    System.Boolean

    Ping(String)

    Declaration
    public void Ping(string playSessionId)
    Parameters
    Type Name Description
    System.String playSessionId

    RegisterPlaySession(PlaybackProgressInfo)

    Declaration
    public void RegisterPlaySession(PlaybackProgressInfo info)
    Parameters
    Type Name Description
    PlaybackProgressInfo info

    RemovePlaySession(PlaySessionInfo)

    Declaration
    public void RemovePlaySession(PlaySessionInfo playSessionInfo)
    Parameters
    Type Name Description
    PlaySessionInfo playSessionInfo

    RemovePlaySession(String)

    Declaration
    public void RemovePlaySession(string playSessionId)
    Parameters
    Type Name Description
    System.String playSessionId

    ReportTranscodingInfo(TranscodingInfo, String)

    Declaration
    public void ReportTranscodingInfo(TranscodingInfo info, string playSessionId)
    Parameters
    Type Name Description
    TranscodingInfo info
    System.String playSessionId

    SupportsCommand(GeneralCommandType)

    Declaration
    public bool SupportsCommand(GeneralCommandType command)
    Parameters
    Type Name Description
    GeneralCommandType command
    Returns
    Type Description
    System.Boolean

    UpdateValues(PlayerStateInfo, PlaybackProgressInfo)

    Declaration
    public static void UpdateValues(PlayerStateInfo playerStateInfo, PlaybackProgressInfo info)
    Parameters
    Type Name Description
    PlayerStateInfo playerStateInfo
    PlaybackProgressInfo info

    Implements

    System.IDisposable

    Extension Methods

    Extensions.JsonClone<T>(T, IJsonSerializer)
    SDK
    On this Page
    Back to Top Copyright 2022 © EMBY LLC. Please see our terms of use and privacy policy.