Quark v1.4.0 Documentation

Documentation Index | Home

Contents

quark/media

quark/media #

Enum: MediaType #

MediaType #

kVideo
Video type
kAudio
Audio type

Enum: MediaSourceStatus #

MediaSourceStatus #

kNormal
Normal status, Uninitialized
kOpening
Opening status
kPlaying
Playing status
kPaused
Paused status
kError
Error status
kEOF
EOF, end status

Enum: AudioChannelLayoutMask #

AudioChannelLayoutMask #

kInvalid
none
kFront_Left
front left
kFront_Right
front right
kFront_Center
front center
kLow_Frequency
low frequency
kBack_Left
back left
kBack_Right
back right
kFront_Left_Of_Center
front left of center
kFront_Right_Of_Center
front right of center
kBack_Center
back center
kSide_Left
side left
kSide_Right
side right
kTop_Center
top center
kTop_Front_Left
top front left
kTop_Front_Center
top front center
kTop_Front_Right
top front right
kTop_Back_Left
top back left
kTop_Back_Center
top back center
kTop_Back_Right
top back right

Interface: Stream #

Stream #

stream.type #

type

readonly type: MediaType

stream.mime #

mime type

readonly mime: string

stream.language #

language

readonly language: string

stream.codecId #

codec id

readonly codecId: number

stream.codecTag #

codec tag

readonly codecTag: number

stream.format #

codec av format output

readonly format: number

stream.profile #

profile

readonly profile: number

stream.level #

level

readonly level: number

stream.width #

video width

readonly width: number

stream.height #

video height

readonly height: number

stream.bitrate #

bit rate

readonly bitrate: number

stream.sampleRate #

audio sample rate

readonly sampleRate: number

stream.channels #

audio channel count

readonly channels: number

stream.channelLayout #

audio channel layout to enum AudioChannelLayoutMask

readonly channelLayout: number

stream.duration #

duration of the stream, in stream time base.

readonly duration: number

stream.avgFramerate #

video frame average framerate

readonly avgFramerate: number[]

stream.timeBase #

Unit of pts,dts on Packet,Frame by Numerator/Denominator (seconds)

readonly timeBase: number[]

stream.index #

stream index in source

readonly index: number

stream.hashCode #

key params hash code

readonly hashCode: number

Interface: Player #

Player #

player.pts #

Presentation timestamp (ms or engine-specific units).

readonly pts: Uint

player.volume #

Playback volume, 0.0–1.0.

volume: number

player.mute #

Whether audio is currently muted.

mute: boolean

player.isPause #

True if media is currently paused.

readonly isPause: boolean

player.type #

Media container type.

readonly type: MediaType

player.duration #

Total duration of the media, in ms.

readonly duration: Uint

player.status #

The playback status of the current media source

readonly status: MediaSourceStatus

player.src #

set/get media source path

src: string

player.video #

Active video stream, if any.

readonly video: Stream | null

player.audio #

Active audio stream, if any.

readonly audio: Stream | null

player.audioStreams #

Get the number of audio tracks in the current media source

readonly audioStreams: Uint

player.play() #

Begin or resume playback.

play(): void

player.pause() #

Pause playback.

pause(): void

player.stop() #

Stop playback completely.

stop(): void

player.seek(timeMs) #

Seek to a new position in the media.

seek(timeMs: Uint): void

Parameters:

timeMs — Target timestamp in milliseconds.

player.switchAudio(index) #

Switch the currently playing audio by track index

switchAudio(index: Uint): void