Function SessionApiAxiosParamCreator

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

• addUserToSession: ((sessionId: string, userId: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  Summary

  Adds an additional user to a session.

  Throws

  • • (sessionId, userId, options?): Promise<RequestArgs>

    • Parameters

      • sessionId: string

        The session id.
      • userId: string

        The user id.
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• displayContent: ((sessionId: string, itemType: BaseItemKind, itemId: string, itemName: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  Summary

  Instructs a session to browse to an item or view.

  Throws

  • • (sessionId, itemType, itemId, itemName, options?): Promise<RequestArgs>

    • 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<RequestArgs>

• getAuthProviders: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  Summary

  Get all auth providers.

  Throws

  • • (options?): Promise<RequestArgs>

    • Parameters

      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• getPasswordResetProviders: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  Summary

  Get all password reset providers.

  Throws

  • • (options?): Promise<RequestArgs>

    • Parameters

      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• getSessions: ((controllableByUserId?: string, deviceId?: string, activeWithinSeconds?: number, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  Summary

  Gets a list of sessions.

  Throws

  • • (controllableByUserId?, deviceId?, activeWithinSeconds?, options?): Promise<RequestArgs>

    • 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<RequestArgs>

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

  Summary

  Instructs a session to play an item.

  Throws

  • • (sessionId, playCommand, itemIds, startPositionTicks?, mediaSourceId?, audioStreamIndex?, subtitleStreamIndex?, startIndex?, options?): Promise<RequestArgs>

    • 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<RequestArgs>

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

  Summary

  Updates capabilities for a device.

  Throws

  • • (id?, playableMediaTypes?, supportedCommands?, supportsMediaControl?, supportsPersistentIdentifier?, options?): Promise<RequestArgs>

    • 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<RequestArgs>

• postFullCapabilities: ((clientCapabilitiesDto: ClientCapabilitiesDto, id?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  Summary

  Updates capabilities for a device.

  Throws

  • • (clientCapabilitiesDto, id?, options?): Promise<RequestArgs>

    • Parameters

      • clientCapabilitiesDto: ClientCapabilitiesDto

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

        The session id.
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• removeUserFromSession: ((sessionId: string, userId: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  Summary

  Removes an additional user from a session.

  Throws

  • • (sessionId, userId, options?): Promise<RequestArgs>

    • Parameters

      • sessionId: string

        The session id.
      • userId: string

        The user id.
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• reportSessionEnded: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  Summary

  Reports that a session has ended.

  Throws

  • • (options?): Promise<RequestArgs>

    • Parameters

      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• reportViewing: ((itemId: string, sessionId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  Summary

  Reports that a session is viewing an item.

  Throws

  • • (itemId, sessionId?, options?): Promise<RequestArgs>

    • Parameters

      • itemId: string

        The item id.
      • OptionalsessionId: string

        The session id.
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• sendFullGeneralCommand: ((sessionId: string, generalCommand: GeneralCommand, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  Summary

  Issues a full general command to a client.

  Throws

  • • (sessionId, generalCommand, options?): Promise<RequestArgs>

    • Parameters

      • sessionId: string

        The session id.
      • generalCommand: GeneralCommand

        The MediaBrowser.Model.Session.GeneralCommand.
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• sendGeneralCommand: ((sessionId: string, command: GeneralCommandType, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  Summary

  Issues a general command to a client.

  Throws

  • • (sessionId, command, options?): Promise<RequestArgs>

    • Parameters

      • sessionId: string

        The session id.
      • command: GeneralCommandType

        The command to send.
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• sendMessageCommand: ((sessionId: string, messageCommand: MessageCommand, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  Summary

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

  Throws

  • • (sessionId, messageCommand, options?): Promise<RequestArgs>

    • 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<RequestArgs>

• sendPlaystateCommand: ((sessionId: string, command: PlaystateCommand, seekPositionTicks?: number, controllingUserId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  Summary

  Issues a playstate command to a client.

  Throws

  • • (sessionId, command, seekPositionTicks?, controllingUserId?, options?): Promise<RequestArgs>

    • 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<RequestArgs>

• sendSystemCommand: ((sessionId: string, command: GeneralCommandType, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  Summary

  Issues a system command to a client.

  Throws

  • • (sessionId, command, options?): Promise<RequestArgs>

    • Parameters

      • sessionId: string

        The session id.
      • command: GeneralCommandType

        The command to send.
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>