Decoder
Defined in: seyd/sdks/js/core/src/decoder.ts:11
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new Decoder(
o):Decoder
Defined in: seyd/sdks/js/core/src/decoder.ts:19
Parameters
Section titled “Parameters”DecoderOptions
Returns
Section titled “Returns”Decoder
Properties
Section titled “Properties”decoded
Section titled “decoded”decoded:
number=0
Defined in: seyd/sdks/js/core/src/decoder.ts:16
errors
Section titled “errors”errors:
number=0
Defined in: seyd/sdks/js/core/src/decoder.ts:15
keyframesRequested
Section titled “keyframesRequested”keyframesRequested:
number=0
Defined in: seyd/sdks/js/core/src/decoder.ts:17
Accessors
Section titled “Accessors”queueSize
Section titled “queueSize”Get Signature
Section titled “Get Signature”get queueSize():
number
Defined in: seyd/sdks/js/core/src/decoder.ts:56
Returns
Section titled “Returns”number
Get Signature
Section titled “Get Signature”get state():
CodecState
Defined in: seyd/sdks/js/core/src/decoder.ts:57
Returns
Section titled “Returns”CodecState
Methods
Section titled “Methods”close()
Section titled “close()”close():
void
Defined in: seyd/sdks/js/core/src/decoder.ts:92
Returns
Section titled “Returns”void
configure()
Section titled “configure()”configure():
void
Defined in: seyd/sdks/js/core/src/decoder.ts:40
Returns
Section titled “Returns”void
decode()
Section titled “decode()”decode(
data,keyframe,timestampUs):boolean
Defined in: seyd/sdks/js/core/src/decoder.ts:78
Returns false if the frame was skipped (no keyframe yet).
Parameters
Section titled “Parameters”Uint8Array
keyframe
Section titled “keyframe”boolean
timestampUs
Section titled “timestampUs”number
Returns
Section titled “Returns”boolean
needKeyframe()
Section titled “needKeyframe()”needKeyframe():
void
Defined in: seyd/sdks/js/core/src/decoder.ts:59
Returns
Section titled “Returns”void
requestRecovery()
Section titled “requestRecovery()”requestRecovery():
void
Defined in: seyd/sdks/js/core/src/decoder.ts:69
Ask for a keyframe without gating decode (used after an unrecoverable delta frame).
Returns
Section titled “Returns”void
supported()
Section titled “supported()”
staticsupported(codec):Promise<boolean>
Defined in: seyd/sdks/js/core/src/decoder.ts:30
Whether this browser can decode the channel’s codec at all.
Worth asking before configuring, because the failure is otherwise silent: the session connects, chunks arrive, frames reassemble, and the canvas stays blank with no error anywhere. H.265 makes this common — Chrome decodes it only where the machine has a hardware HEVC decoder, so the same stream plays on one laptop and shows nothing on another.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<boolean>