Function SessionApiFp

Returns {
    addUserToSession(
        sessionId: string,
        userId: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>,
    >;
    displayContent(
        sessionId: string,
        itemType: BaseItemKind,
        itemId: string,
        itemName: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>,
    >;
    getAuthProviders(
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<NameIdPair[]>,
    >;
    getPasswordResetProviders(
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<NameIdPair[]>,
    >;
    getSessions(
        controllableByUserId?: string,
        deviceId?: string,
        activeWithinSeconds?: number,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<SessionInfoDto[]>,
    >;
    play(
        sessionId: string,
        playCommand: PlayCommand,
        itemIds: string[],
        startPositionTicks?: number,
        mediaSourceId?: string,
        audioStreamIndex?: number,
        subtitleStreamIndex?: number,
        startIndex?: number,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>,
    >;
    postCapabilities(
        id?: string,
        playableMediaTypes?: MediaType[],
        supportedCommands?: GeneralCommandType[],
        supportsMediaControl?: boolean,
        supportsPersistentIdentifier?: boolean,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>,
    >;
    postFullCapabilities(
        clientCapabilitiesDto: ClientCapabilitiesDto,
        id?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>,
    >;
    removeUserFromSession(
        sessionId: string,
        userId: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>,
    >;
    reportSessionEnded(
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>,
    >;
    reportViewing(
        itemId: string,
        sessionId?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>,
    >;
    sendFullGeneralCommand(
        sessionId: string,
        generalCommand: GeneralCommand,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>,
    >;
    sendGeneralCommand(
        sessionId: string,
        command: GeneralCommandType,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>,
    >;
    sendMessageCommand(
        sessionId: string,
        messageCommand: MessageCommand,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>,
    >;
    sendPlaystateCommand(
        sessionId: string,
        command: PlaystateCommand,
        seekPositionTicks?: number,
        controllingUserId?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>,
    >;
    sendSystemCommand(
        sessionId: string,
        command: GeneralCommandType,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>,
    >;
}

• addUserToSession: function

  • addUserToSession(
        sessionId: string,
        userId: string,
        options?: RawAxiosRequestConfig,
    ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

    Parameters

    • sessionId: string

      The session id.
    • userId: string

      The user id.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

    Throws

• displayContent: function

  • displayContent(
        sessionId: string,
        itemType: BaseItemKind,
        itemId: string,
        itemName: string,
        options?: RawAxiosRequestConfig,
    ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

    Parameters

    • sessionId: string

      The session Id.
    • itemType: BaseItemKind

      The type of item to browse to.
    • itemId: string

      The Id of the item.
    • itemName: string

      The name of the item.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

    Throws

• getAuthProviders: function

  • getAuthProviders(
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<NameIdPair[]>,
    >

    Parameters

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<NameIdPair[]>,
    >

    Throws

• getPasswordResetProviders: function

  • getPasswordResetProviders(
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<NameIdPair[]>,
    >

    Parameters

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<NameIdPair[]>,
    >

    Throws

• getSessions: function

  • getSessions(
        controllableByUserId?: string,
        deviceId?: string,
        activeWithinSeconds?: number,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<SessionInfoDto[]>,
    >

    Parameters

    • OptionalcontrollableByUserId: string

      Filter by sessions that a given user is allowed to remote control.
    • OptionaldeviceId: string

      Filter by device Id.
    • OptionalactiveWithinSeconds: number

      Optional. Filter by sessions that were active in the last n seconds.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<SessionInfoDto[]>,
    >

    Throws

• play: function

  • play(
        sessionId: string,
        playCommand: PlayCommand,
        itemIds: string[],
        startPositionTicks?: number,
        mediaSourceId?: string,
        audioStreamIndex?: number,
        subtitleStreamIndex?: number,
        startIndex?: number,
        options?: RawAxiosRequestConfig,
    ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

    Parameters

    • sessionId: string

      The session id.
    • playCommand: PlayCommand

      The type of play command to issue (PlayNow, PlayNext, PlayLast). Clients who have not yet implemented play next and play last may play now.
    • itemIds: string[]

      The ids of the items to play, comma delimited.
    • OptionalstartPositionTicks: number

      The starting position of the first item.
    • OptionalmediaSourceId: string

      Optional. The media source id.
    • OptionalaudioStreamIndex: number

      Optional. The index of the audio stream to play.
    • OptionalsubtitleStreamIndex: number

      Optional. The index of the subtitle stream to play.
    • OptionalstartIndex: number

      Optional. The start index.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

    Throws

• postCapabilities: function

  • postCapabilities(
        id?: string,
        playableMediaTypes?: MediaType[],
        supportedCommands?: GeneralCommandType[],
        supportsMediaControl?: boolean,
        supportsPersistentIdentifier?: boolean,
        options?: RawAxiosRequestConfig,
    ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

    Parameters

    • Optionalid: string

      The session id.
    • OptionalplayableMediaTypes: MediaType[]

      A list of playable media types, comma delimited. Audio, Video, Book, Photo.
    • OptionalsupportedCommands: GeneralCommandType[]

      A list of supported remote control commands, comma delimited.
    • OptionalsupportsMediaControl: boolean

      Determines whether media can be played remotely..
    • OptionalsupportsPersistentIdentifier: boolean

      Determines whether the device supports a unique identifier.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

    Throws

• postFullCapabilities: function

  • postFullCapabilities(
        clientCapabilitiesDto: ClientCapabilitiesDto,
        id?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

    Parameters

    • clientCapabilitiesDto: ClientCapabilitiesDto

      The MediaBrowser.Model.Session.ClientCapabilities.
    • Optionalid: string

      The session id.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

    Throws

• removeUserFromSession: function

  • removeUserFromSession(
        sessionId: string,
        userId: string,
        options?: RawAxiosRequestConfig,
    ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

    Parameters

    • sessionId: string

      The session id.
    • userId: string

      The user id.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

    Throws

• reportSessionEnded: function

  • reportSessionEnded(
        options?: RawAxiosRequestConfig,
    ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

    Parameters

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

    Throws

• reportViewing: function

  • reportViewing(
        itemId: string,
        sessionId?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

    Parameters

    • itemId: string

      The item id.
    • OptionalsessionId: string

      The session id.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

    Throws

• sendFullGeneralCommand: function

  • sendFullGeneralCommand(
        sessionId: string,
        generalCommand: GeneralCommand,
        options?: RawAxiosRequestConfig,
    ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

    Parameters

    • sessionId: string

      The session id.
    • generalCommand: GeneralCommand

      The MediaBrowser.Model.Session.GeneralCommand.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

    Throws

• sendGeneralCommand: function

  • sendGeneralCommand(
        sessionId: string,
        command: GeneralCommandType,
        options?: RawAxiosRequestConfig,
    ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

    Parameters

    • sessionId: string

      The session id.
    • command: GeneralCommandType

      The command to send.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

    Throws

• sendMessageCommand: function

  • sendMessageCommand(
        sessionId: string,
        messageCommand: MessageCommand,
        options?: RawAxiosRequestConfig,
    ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

    Parameters

    • sessionId: string

      The session id.
    • messageCommand: MessageCommand

      The MediaBrowser.Model.Session.MessageCommand object containing Header, Message Text, and TimeoutMs.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

    Throws

• sendPlaystateCommand: function

  • sendPlaystateCommand(
        sessionId: string,
        command: PlaystateCommand,
        seekPositionTicks?: number,
        controllingUserId?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

    Parameters

    • sessionId: string

      The session id.
    • command: PlaystateCommand

      The MediaBrowser.Model.Session.PlaystateCommand.
    • OptionalseekPositionTicks: number

      The optional position ticks.
    • OptionalcontrollingUserId: string

      The optional controlling user id.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

    Throws

• sendSystemCommand: function

  • sendSystemCommand(
        sessionId: string,
        command: GeneralCommandType,
        options?: RawAxiosRequestConfig,
    ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

    Parameters

    • sessionId: string

      The session id.
    • command: GeneralCommandType

      The command to send.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

    Throws