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, userId, options?): 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>)>

    Summary

    Adds an additional user to a session.

    Throws

• displayContent:function

  • displayContent(sessionId, itemType, itemId, itemName, options?): 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>)>

    Summary

    Instructs a session to browse to an item or view.

    Throws

• getAuthProviders:function

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

  • Parameters

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Summary

    Get all auth providers.

    Throws

• getPasswordResetProviders:function

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

  • Parameters

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Summary

    Get all password reset providers.

    Throws

• getSessions:function

  • getSessions(controllableByUserId?, deviceId?, activeWithinSeconds?, options?): 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[]>)>

    Summary

    Gets a list of sessions.

    Throws

• play:function

  • play(sessionId, playCommand, itemIds, startPositionTicks?, mediaSourceId?, audioStreamIndex?, subtitleStreamIndex?, startIndex?, options?): 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>)>

    Summary

    Instructs a session to play an item.

    Throws

• postCapabilities:function

  • postCapabilities(id?, playableMediaTypes?, supportedCommands?, supportsMediaControl?, supportsPersistentIdentifier?, options?): 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>)>

    Summary

    Updates capabilities for a device.

    Throws

• postFullCapabilities:function

  • postFullCapabilities(clientCapabilitiesDto, id?, options?): 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>)>

    Summary

    Updates capabilities for a device.

    Throws

• removeUserFromSession:function

  • removeUserFromSession(sessionId, userId, options?): 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>)>

    Summary

    Removes an additional user from a session.

    Throws

• reportSessionEnded:function

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

  • Parameters

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Summary

    Reports that a session has ended.

    Throws

• reportViewing:function

  • reportViewing(itemId, sessionId?, options?): 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>)>

    Summary

    Reports that a session is viewing an item.

    Throws

• sendFullGeneralCommand:function

  • sendFullGeneralCommand(sessionId, generalCommand, options?): 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>)>

    Summary

    Issues a full general command to a client.

    Throws

• sendGeneralCommand:function

  • sendGeneralCommand(sessionId, command, options?): 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>)>

    Summary

    Issues a general command to a client.

    Throws

• sendMessageCommand:function

  • sendMessageCommand(sessionId, messageCommand, options?): 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>)>

    Summary

    Issues a command to a client to display a message to the user.

    Throws

• sendPlaystateCommand:function

  • sendPlaystateCommand(sessionId, command, seekPositionTicks?, controllingUserId?, options?): 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>)>

    Summary

    Issues a playstate command to a client.

    Throws

• sendSystemCommand:function

  • sendSystemCommand(sessionId, command, options?): 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>)>

    Summary

    Issues a system command to a client.

    Throws