Class MediaPart

Hierarchy

PlexObject
- MediaPart

Index

Constructors

constructor

new MediaPart(
    server: PlexServer,
    data: any,
    initpath?: string,
    parent?: PlexObject,
): MediaPart
Parameters
- server: PlexServer
- data: any
- Optionalinitpath: string
- Optionalparent: PlexObject
Returns MediaPart
Inherited from PlexObject.constructor
- Defined in src/base/plexObject.ts:23

Properties

container

container: string

duration

duration: number

`Optional`exists

exists?: boolean

file

file: string

id

id: number

indexes

indexes: string

key

key: string

plex relative url

optimizedForStreaming

optimizedForStreaming: boolean

`Optional` `Readonly`parent

parent?: WeakRef<any>

WeakRef to the parent object that this object is built from.

`Readonly`server

server: PlexServer

size

size: number

streams

streams: MediaPartStream[]

syncItemId

syncItemId: string

syncState

syncState: string

videoProfile

videoProfile: string

`Static`TAG

TAG: "Part" = ...

xml element tag

`Static`TYPE

TYPE: string = null

xml element type

Methods

audioStreams

audioStreams(): AudioStream[]
Returns a list of AudioStream objects in this MediaPart.

Returns AudioStream[]
- Defined in src/media.ts:148

isChildOf

isChildOf(cls: any): boolean
Returns True if this object is a child of the given class.
Parameters
- cls: any
Returns boolean
Inherited from PlexObject.isChildOf
- Defined in src/base/plexObject.ts:63

lyricStreams

lyricStreams(): LyricStream[]
Returns a list of LyricStream objects in this MediaPart.

Returns LyricStream[]
- Defined in src/media.ts:164

refresh

refresh(): Promise<void>
Refreshing a Library or individual item causes the metadata for the item to be refreshed, even if it already has metadata. You can think of refreshing as "update metadata for the requested item even if it already has some". You should refresh a Library or individual item if:

Returns Promise<void>
Inherited from PlexObject.refresh
- Defined in src/base/plexObject.ts:55

reload

reload(ekey?: string): Promise<void>
Reload the data for this object from this.key.
Parameters
- Optionalekey: string
Returns Promise<void>
Inherited from PlexObject.reload
- Defined in src/base/plexObject.ts:38

setSelectedAudioStream

setSelectedAudioStream(stream: number | AudioStream): Promise<MediaPart>
Set the selected AudioStream for this MediaPart.
Parameters
- stream: number | AudioStream
  Audio stream or stream ID to set as selected.
Returns Promise<MediaPart>
- Defined in src/media.ts:123

setSelectedSubtitleStream

setSelectedSubtitleStream(stream: number | SubtitleStream): Promise<MediaPart>
Set the selected SubtitleStream for this MediaPart.
Parameters
- stream: number | SubtitleStream
  Subtitle stream or stream ID to set as selected.
Returns Promise<MediaPart>
- Defined in src/media.ts:136

subtitleStreams

subtitleStreams(): SubtitleStream[]
Returns a list of SubtitleStream objects in this MediaPart.

Returns SubtitleStream[]
- Defined in src/media.ts:155