SleelaDoc API
HTML documentation for the SLeeLa standard library (/lib)
Home › Packages › video

Package video

This package contains 21 source unit(s) defining 23 class(es) / struct(s). Each unit below lists its fields (the values it stores) and methods (the actions it performs), with a plain explanation of each.

Video #sleela 2.5 (lib/video/Video.sleela)

Video class

Defines the SLeeLa standard-library type Video used within the video library family.

Carries the standard Metadata Class record — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
titlestring titleNo description in source.
timelineVideoTimeline timelineNo description in source.
codecVideoCodec codecNo description in source.

Methods — the actions this unit can perform.

MethodSignatureWhat it does
setTitlevoid setTitle(string value)No description in source.
getTitlestring getTitle()No description in source.
readyboolean ready()No description in source.

video-codec-pipeline #sleela 2.5 (lib/video/video-codec-pipeline.sleela)

Verifier class

Carries the standard Metadata Class record — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.

Methods — the actions this unit can perform.

MethodSignatureWhat it does
resolveExtensionint resolveExtension(string ext)No description in source.
resultTextstring resultText(int code)No description in source.

Processor class

Methods — the actions this unit can perform.

MethodSignatureWhat it does
decodeint decode(boolean loaded, boolean nativeCodec, boolean backendReady)No description in source.
encodeint encode(boolean loaded, boolean nativeCodec, boolean backendReady)No description in source.

Controller class

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
loadedint[] loadedNo description in source.
backendint[] backendNo description in source.
verifierVerifier verifierwired by create(), called via the field (1.11)
processorProcessor processorNo description in source.

Methods — the actions this unit can perform.

MethodSignatureWhat it does
createvoid create()No description in source.
countint count()No description in source.
isNativeboolean isNative(int id)No description in source.
nameOfstring nameOf(int id)No description in source.
loadint load(int id)No description in source.
isLoadedboolean isLoaded(int id)No description in source.
unloadAllvoid unloadAll()No description in source.
registerBackendint registerBackend(int id)No description in source.
hasBackendboolean hasBackend(int id)No description in source.
loadedCountint loadedCount()No description in source.
resolveExtensionint resolveExtension(string ext)Clean facade methods: delegate to the wired collaborators.
resultTextstring resultText(int code)No description in source.
decodeint decode(int id)No description in source.
encodeint encode(int id)No description in source.
mainvoid main()No description in source.

VideoCodec #sleela 2.5 (lib/video/VideoCodec.sleela)

VideoCodec class

Defines the SLeeLa standard-library type VideoCodec used within the video library family.

Carries the standard Metadata Class record — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
namestring nameNo description in source.
profilestring profileNo description in source.
decoderboolean decoderNo description in source.
encoderboolean encoderNo description in source.

Methods — the actions this unit can perform.

MethodSignatureWhat it does
identifyvoid identify(string codec,string codecProfile)No description in source.
capabilitiesvoid capabilities(boolean decode,boolean encode)No description in source.
supportedboolean supported()No description in source.

VideoCodecCatalog #sleela 2.5 (lib/video/VideoCodecCatalog.sleela)

VideoCodecCatalog class

Defines the SLeeLa standard-library type VideoCodecCatalog used within the video library family.

Carries the standard Metadata Class record — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
countint countNo description in source.

Methods — the actions this unit can perform.

MethodSignatureWhat it does
initializevoid initialize()No description in source.
sizeint size()No description in source.
containsboolean contains(string name)No description in source.

VideoCodecController #sleela 2.5 (lib/video/VideoCodecController.sleela)

VideoCodecController class

Defines the SLeeLa standard-library type VideoCodecController used within the video library family.

Carries the standard Metadata Class record — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
verifierVideoCodecVerifier verifierwired by create(), called via the field. (Lifecycle tables + ready flag are inherited from SLPluginService.)

Methods — the actions this unit can perform.

MethodSignatureWhat it does
createvoid create()Build the controller: configure() (inherited) allocates the 12-entry lifecycle tables and records the native-id mask; then wire the Verifier. Only Raw Video (0) is native -> mask bit 0.
isQualifiedBackendboolean isQualifiedBackend(int id)Video-specific: ProRes/DNx (10, 11) are the qualified backends.
resolveExtensionint resolveExtension(string extension)Resolve a codec id from a file extension via the wired Verifier.
decodeint decode(int id)Domain verbs over the inherited dispatch gate (-2 invalid, -5 not loaded, -1 backend absent, 0 ok).
encodeint encode(int id)No description in source.
serviceNamestring serviceName()No description in source.
resultTextstring resultText(int code)No description in source.

VideoCodecLoader #sleela 2.5 (lib/video/VideoCodecLoader.sleela)

VideoCodecLoader class

Defines the SLeeLa standard-library type VideoCodecLoader used within the video library family.

Carries the standard Metadata Class record — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
loadedint[] loadedPer-codec loaded flag (1 loaded, 0 not), indexed by codec id. Call init().

Methods — the actions this unit can perform.

MethodSignatureWhat it does
codecCountint codecCount()Number of video codecs the native registry knows (SLEELA_VIDEO_CODEC_COUNT).
initvoid init()No description in source.
loadvoid load(int id)No description in source.
unloadvoid unload(int id)No description in source.
isLoadedboolean isLoaded(int id)No description in source.
unloadAllvoid unloadAll()No description in source.
nameOfstring nameOf(int id)Human-readable codec name by id, matching the native registry.
isNativeboolean isNative(int id)Only Raw Video (0) encodes/decodes natively; every other video codec is a backend (ProRes/DNx are qualified backends). Mirrors the registry state.
isQualifiedBackendboolean isQualifiedBackend(int id)ProRes (10) and DNx (11) need a specially qualified backend adapter.

VideoCodecProcessor #sleela 2.5 (lib/video/VideoCodecProcessor.sleela)

VideoCodecProcessor class

Defines the SLeeLa standard-library type VideoCodecProcessor used within the video library family.

Carries the standard Metadata Class record — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.

Methods — the actions this unit can perform.

MethodSignatureWhat it does
canProcessboolean canProcess(boolean loaded, boolean nativeCodec, boolean backendReady)No description in source.
decodeint decode(boolean loaded, boolean nativeCodec, boolean backendReady)No description in source.
encodeint encode(boolean loaded, boolean nativeCodec, boolean backendReady)No description in source.

VideoCodecVerifier #sleela 2.5 (lib/video/VideoCodecVerifier.sleela)

VideoCodecVerifier class

Defines the SLeeLa standard-library type VideoCodecVerifier used within the video library family.

Carries the standard Metadata Class record — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.

Methods — the actions this unit can perform.

MethodSignatureWhat it does
resolveExtensionint resolveExtension(string ext)Resolve a video codec id from a file extension, or -1 if unknown. Extensions are taken verbatim from the native video registry; note some containers (.webm, .mov) are shared and resolve to a representative codec.
verifyLoadableint verifyLoadable(int id)No description in source.
resultTextstring resultText(int code)No description in source.
okboolean ok(int code)No description in source.

VideoDecoder #sleela 2.5 (lib/video/VideoDecoder.sleela)

VideoDecoder class

Defines the SLeeLa standard-library type VideoDecoder used within the video library family.

Carries the standard Metadata Class record — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
codecVideoCodec codecNo description in source.
profileVideoProfile profileNo description in source.
openboolean openNo description in source.

Methods — the actions this unit can perform.

MethodSignatureWhat it does
configurevoid configure(VideoCodec c,VideoProfile p)No description in source.
startvoid start()No description in source.
readyboolean ready()No description in source.
stopvoid stop()No description in source.

VideoEncoder #sleela 2.5 (lib/video/VideoEncoder.sleela)

VideoEncoder class

Defines the SLeeLa standard-library type VideoEncoder used within the video library family.

Carries the standard Metadata Class record — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
codecVideoCodec codecNo description in source.
formatVideoFormat formatNo description in source.
openboolean openNo description in source.

Methods — the actions this unit can perform.

MethodSignatureWhat it does
configurevoid configure(VideoCodec c,VideoFormat f)No description in source.
startvoid start()No description in source.
readyboolean ready()No description in source.
stopvoid stop()No description in source.

VideoFormat #sleela 2.5 (lib/video/VideoFormat.sleela)

VideoFormat class

Defines the SLeeLa standard-library type VideoFormat used within the video library family.

Carries the standard Metadata Class record — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
widthint widthNo description in source.
heightint heightNo description in source.
frameRateNumeratorint frameRateNumeratorNo description in source.
frameRateDenominatorint frameRateDenominatorNo description in source.
pixelFormatVideoPixelFormat pixelFormatNo description in source.

Methods — the actions this unit can perform.

MethodSignatureWhat it does
validboolean valid()No description in source.

VideoFrame #sleela 2.5 (lib/video/VideoFrame.sleela)

VideoFrame class

Defines the SLeeLa standard-library type VideoFrame used within the video library family.

Carries the standard Metadata Class record — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
widthint widthNo description in source.
heightint heightNo description in source.
formatVideoPixelFormat formatNo description in source.
timestamplong timestampNo description in source.

Methods — the actions this unit can perform.

MethodSignatureWhat it does
validboolean valid()No description in source.
resizevoid resize(int w,int h)No description in source.

VideoFrameBuffer #sleela 2.5 (lib/video/VideoFrameBuffer.sleela)

VideoFrameBuffer class

Defines the SLeeLa standard-library type VideoFrameBuffer used within the video library family.

Carries the standard Metadata Class record — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
bytesint bytesNo description in source.
strideint strideNo description in source.
planesint planesNo description in source.

Methods — the actions this unit can perform.

MethodSignatureWhat it does
describevoid describe(int size,int row,int count)No description in source.
validboolean valid()No description in source.

VideoPixelFormat #sleela 2.5 (lib/video/VideoPixelFormat.sleela)

VideoPixelFormat class

Defines the SLeeLa standard-library type VideoPixelFormat used within the video library family.

Carries the standard Metadata Class record — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
namestring nameNo description in source.
planesint planesNo description in source.

Methods — the actions this unit can perform.

MethodSignatureWhat it does
setvoid set(string value,int count)No description in source.
validboolean valid()No description in source.

VideoProfile #sleela 2.5 (lib/video/VideoProfile.sleela)

VideoProfile class

Defines the SLeeLa standard-library type VideoProfile used within the video library family.

Carries the standard Metadata Class record — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
namestring nameNo description in source.
levelint levelNo description in source.
bitDepthint bitDepthNo description in source.

Methods — the actions this unit can perform.

MethodSignatureWhat it does
setvoid set(string value,int profileLevel,int depth)No description in source.
validboolean valid()No description in source.

VideoRenderer #sleela 2.5 (lib/video/VideoRenderer.sleela)

VideoRenderer class

Defines the SLeeLa standard-library type VideoRenderer used within the video library family.

Carries the standard Metadata Class record — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
frameVideoFrame frameNo description in source.
activeboolean activeNo description in source.

Methods — the actions this unit can perform.

MethodSignatureWhat it does
attachvoid attach(VideoFrame value)No description in source.
startvoid start()No description in source.
renderableboolean renderable()No description in source.
stopvoid stop()No description in source.

VideoStream #sleela 2.5 (lib/video/VideoStream.sleela)

VideoStream class

Defines the SLeeLa standard-library type VideoStream used within the video library family.

Carries the standard Metadata Class record — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
identifierstring identifierNo description in source.
trackVideoTrack trackNo description in source.
activeboolean activeNo description in source.

Methods — the actions this unit can perform.

MethodSignatureWhat it does
openvoid open(string id,VideoTrack value)No description in source.
runningboolean running()No description in source.
closevoid close()No description in source.

VideoTimeline #sleela 2.5 (lib/video/VideoTimeline.sleela)

VideoTimeline class

Defines the SLeeLa standard-library type VideoTimeline used within the video library family.

Carries the standard Metadata Class record — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
beginlong beginNo description in source.
endlong endNo description in source.
framesint framesNo description in source.

Methods — the actions this unit can perform.

MethodSignatureWhat it does
setRangevoid setRange(long start,long finish)No description in source.
addFramevoid addFrame()No description in source.
durationlong duration()No description in source.

VideoTimestamp #sleela 2.5 (lib/video/VideoTimestamp.sleela)

VideoTimestamp class

Defines the SLeeLa standard-library type VideoTimestamp used within the video library family.

Carries the standard Metadata Class record — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
valuelong valueNo description in source.
numeratorint numeratorNo description in source.
denominatorint denominatorNo description in source.

Methods — the actions this unit can perform.

MethodSignatureWhat it does
setvoid set(long v,int n,int d)No description in source.
validboolean valid()No description in source.

VideoTrack #sleela 2.5 (lib/video/VideoTrack.sleela)

VideoTrack class

Defines the SLeeLa standard-library type VideoTrack used within the video library family.

Carries the standard Metadata Class record — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
namestring nameNo description in source.
frameCountint frameCountNo description in source.
formatVideoFormat formatNo description in source.

Methods — the actions this unit can perform.

MethodSignatureWhat it does
configurevoid configure(string trackName,VideoFormat trackFormat)No description in source.
addFramevoid addFrame()No description in source.
framesint frames()No description in source.

VideoWork #sleela 2.5 (lib/video/VideoWork.sleela)

VideoWork class

Defines the SLeeLa standard-library type VideoWork used within the video library family.

Carries the standard Metadata Class record — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
videoVideo videoNo description in source.
rendererVideoRenderer rendererNo description in source.
encoderVideoEncoder encoderNo description in source.
decoderVideoDecoder decoderNo description in source.

Methods — the actions this unit can perform.

MethodSignatureWhat it does
composevoid compose(Video value)No description in source.
readyboolean ready()No description in source.
preparevoid prepare()No description in source.
preparedboolean prepared()No description in source.