Tsarr Documentation - v2.16.0
    Preparing search index...

    Type Alias SessionInfoDtoWritable

    Session info DTO.

    type SessionInfoDtoWritable = {
        PlayState?: PlayerStateInfo | null;
        AdditionalUsers?: SessionUserInfo[] | null;
        Capabilities?: ClientCapabilitiesDto | null;
        RemoteEndPoint?: string | null;
        PlayableMediaTypes?: MediaType[];
        Id?: string | null;
        UserId?: string;
        UserName?: string | null;
        Client?: string | null;
        LastActivityDate?: string;
        LastPlaybackCheckIn?: string;
        LastPausedDate?: string | null;
        DeviceName?: string | null;
        DeviceType?: string | null;
        NowPlayingItem?: BaseItemDtoWritable | null;
        NowViewingItem?: BaseItemDtoWritable | null;
        DeviceId?: string | null;
        ApplicationVersion?: string | null;
        TranscodingInfo?: TranscodingInfo | null;
        IsActive?: boolean;
        SupportsMediaControl?: boolean;
        SupportsRemoteControl?: boolean;
        NowPlayingQueue?: QueueItem[] | null;
        HasCustomDeviceName?: boolean;
        PlaylistItemId?: string | null;
        ServerId?: string | null;
        UserPrimaryImageTag?: string | null;
        SupportedCommands?: GeneralCommandType[];
    }
    Index
    PlayState? AdditionalUsers? Capabilities? RemoteEndPoint? PlayableMediaTypes? Id? UserId? UserName? Client? LastActivityDate? LastPlaybackCheckIn? LastPausedDate? DeviceName? DeviceType? NowPlayingItem? NowViewingItem? DeviceId? ApplicationVersion? TranscodingInfo? IsActive? SupportsMediaControl? SupportsRemoteControl? NowPlayingQueue? HasCustomDeviceName? PlaylistItemId? ServerId? UserPrimaryImageTag? SupportedCommands?
    PlayState?: PlayerStateInfo | null

    Gets or sets the play state.

    AdditionalUsers?: SessionUserInfo[] | null

    Gets or sets the additional users.

    Capabilities?: ClientCapabilitiesDto | null

    Gets or sets the client capabilities.

    RemoteEndPoint?: string | null

    Gets or sets the remote end point.

    PlayableMediaTypes?: MediaType[]

    Gets or sets the playable media types.

    Id?: string | null

    Gets or sets the id.

    UserId?: string

    Gets or sets the user id.

    UserName?: string | null

    Gets or sets the username.

    Client?: string | null

    Gets or sets the type of the client.

    LastActivityDate?: string

    Gets or sets the last activity date.

    LastPlaybackCheckIn?: string

    Gets or sets the last playback check in.

    LastPausedDate?: string | null

    Gets or sets the last paused date.

    DeviceName?: string | null

    Gets or sets the name of the device.

    DeviceType?: string | null

    Gets or sets the type of the device.

    NowPlayingItem?: BaseItemDtoWritable | null

    Gets or sets the now playing item.

    NowViewingItem?: BaseItemDtoWritable | null

    Gets or sets the now viewing item.

    DeviceId?: string | null

    Gets or sets the device id.

    ApplicationVersion?: string | null

    Gets or sets the application version.

    TranscodingInfo?: TranscodingInfo | null

    Gets or sets the transcoding info.

    IsActive?: boolean

    Gets or sets a value indicating whether this session is active.

    SupportsMediaControl?: boolean

    Gets or sets a value indicating whether the session supports media control.

    SupportsRemoteControl?: boolean

    Gets or sets a value indicating whether the session supports remote control.

    NowPlayingQueue?: QueueItem[] | null

    Gets or sets the now playing queue.

    HasCustomDeviceName?: boolean

    Gets or sets a value indicating whether this session has a custom device name.

    PlaylistItemId?: string | null

    Gets or sets the playlist item id.

    ServerId?: string | null

    Gets or sets the server id.

    UserPrimaryImageTag?: string | null

    Gets or sets the user primary image tag.

    SupportedCommands?: GeneralCommandType[]

    Gets or sets the supported commands.

    Settings
    Member Visibility

    On This Page
    Properties