groove/audiobookshelf
1
0
Fork 0
mirror of https://github.com/advplyr/audiobookshelf.git synced 2026-07-12 20:31:36 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

PlaybackSession schema cleanup

Browse source
This commit is contained in:
Nicholas Wallace 2024-03-01 23:27:57 +00:00
parent 1c5798181a
commit 02a4014342
2 changed files with 140 additions and 273 deletions
Download patch file Download diff file Expand all files Collapse all files

169
server/objects/PlaybackSession.js
View file

@ -10,25 +10,49 @@ const VideoMetadata = require('./metadata/VideoMetadata')
* @openapi
* components:
* schemas:
* playbackSession:
* oldPlaybackSessionId:
* description: The ID of playback sessions on server version 2.2.23 and before.
* type: string
* format: "play_[a-z0-9]{18}"
* example: play_o78uaoeuh78h6aoeif
* newPlaybackSessionId:
* type: string
* description: The ID of playback sessions after 2.3.0.
* format: uuid
* example: e4bb1afb-4a4f-4dd6-8be0-e615d233185b
* playbackSessionId:
* type: string
* anyOf:
* - $ref: '#/components/schemas/oldPlaybackSessionId'
* - $ref: '#/components/schemas/newPlaybackSessionId'
* playMethod:
* type: integer
* oneOf:
* - title: Direct Play
* const: 0
* description: Direct play media from server without transcoding
* - title: Direct Stream
* const: 1
* description: Direct stream media from server without transcoding
* - title: Transcode
* const: 2
* description: Server is transcoding media for client
* - title: Local
* const: 3
* description: Client is playing from a local file
* playbackSessionBase:
* type: object
* properties:
* id:
* description: The ID of the playback session.
* type: string
* example: play_c786zm3qtjz6bd5q3n
* $ref: '#/components/schemas/playbackSessionId'
* userId:
* description: The ID of the user the playback session is for.
* type: string
* example: root
* libraryId:
* oneOf:
* - $ref: '#/components/schemas/oldLibraryId'
* - $ref: '#/components/schemas/newLibraryId'
* $ref: '#/components/schemas/libraryId'
* libraryItemId:
* description: The ID of the library item.
* type: string
* example: li_bufnnmp4y5o2gbbxfm
* $ref: '#/components/schemas/libraryItemId'
* episodeId:
* description: The ID of the podcast episode. Will be null if this playback session was started without an episode ID.
* type: string
@ -65,8 +89,7 @@ const VideoMetadata = require('./metadata/VideoMetadata')
* example: 1454.18449
* playMethod:
* description: What play method the playback session is using. See below for values.
* type: integer
* example: 0
* $ref: '#/components/schemas/playMethod'
* mediaPlayer:
* description: The given media player when the playback session was requested.
* type: string
@ -104,110 +127,28 @@ const VideoMetadata = require('./metadata/VideoMetadata')
* example: 1668206493239
* updatedAt:
* $ref: '#/components/schemas/updatedAt'
* playbackSession:
* type: object
* description: A playback session for a user
* allOf:
* - $ref : '#/components/schemas/playbackSessionBase'
* playbackSessionExpanded:
* type: [object, 'null']
* properties:
* id:
* description: The ID of the playback session.
* type: string
* example: play_c786zm3qtjz6bd5q3n
* userId:
* description: The ID of the user the playback session is for.
* type: string
* example: root
* libraryId:
* oneOf:
* - $ref: '#/components/schemas/oldLibraryId'
* - $ref: '#/components/schemas/newLibraryId'
* libraryItemId:
* description: The ID of the library item.
* type: string
* example: li_bufnnmp4y5o2gbbxfm
* episodeId:
* description: The ID of the podcast episode. Will be null if this playback session was started without an episode ID.
* type: string
* example: ep_lh6ko39pumnrma3dhv
* mediaType:
* - $ref: '#/components/schemas/mediaType'
* mediaMetadata:
* description: The metadata of the library item's media.
* type: object
* additionalProperties:
* oneOf:
* - $ref: '#/components/schemas/bookMetadata'
* - $ref: '#/components/schemas/podcastMetadata'
* chapters:
* description: If the library item is a book, the chapters it contains.
* type: array
* items:
* $ref: '#/components/schemas/bookChapter'
* displayTitle:
* description: The title of the playing item to show to the user.
* type: string
* example: Pilot
* displayAuthor:
* description: The author of the playing item to show to the user.
* type: string
* example: Night Vale Presents
* coverPath:
* description: The cover path of the library item's media.
* type: string
* example: /metadata/items/li_bufnnmp4y5o2gbbxfm/cover.jpg
* duration:
* description: The total duration (in seconds) of the playing item.
* type: number
* example: 1454.18449
* playMethod:
* description: What play method the playback session is using. See below for values.
* type: integer
* example: 0
* mediaPlayer:
* description: The given media player when the playback session was requested.
* type: string
* example: unknown
* deviceInfo:
* $ref: '#/components/schemas/deviceInfo'
* serverVersion:
* description: The server version the playback session was started with.
* type: string
* example: 2.4.4
* date:
* description: The day (in the format YYYY-MM-DD) the playback session was started.
* type: string
* example: '2022-11-11'
* format: date
* dayOfWeek:
* description: The day of the week the playback session was started.
* type: string
* example: Friday
* timeListening:
* description: The amount of time (in seconds) the user has spent listening using this playback session.
* type: number
* example: 0
* startTime:
* description: The time (in seconds) where the playback session started.
* type: number
* example: 0
* currentTime:
* description: The current time (in seconds) of the playback position.
* type: number
* example: 0
* startedAt:
* description: The time (in ms since POSIX epoch) when the playback session was started.
* type: integer
* example: 1668206493239
* updatedAt:
* $ref: '#/components/schemas/updatedAt'
* audioTracks:
* description: The audio tracks that are being played with the playback session.
* type: array
* items:
* $ref: '#/components/schemas/audioFile'
* videoTrack:
* description: The video track that is being played with the playback session. Will be null if the playback session is for a book or podcast. (Video Track Object does not exist)
* type: [string, 'null']
* libraryItem:
* $ref: '#/components/schemas/libraryItemExpanded'
* description: An expanded playback session for a user
* allOf:
* - $ref : '#/components/schemas/playbackSessionBase'
* - type: object
* properties:
* audioTracks:
* description: The audio tracks that are being played with the playback session.
* type: array
* items:
* $ref: '#/components/schemas/audioFile'
* videoTrack:
* description: The video track that is being played with the playback session. Will be null if the playback session is for a book or podcast. (Video Track Object does not exist)
* type: [string, 'null']
* libraryItem:
* $ref: '#/components/schemas/libraryItemExpanded'
*/
class PlaybackSession {
constructor(session) {