Expand description
End-to-end packaging pipeline for the sheathe packager.
package takes one or more input media files (MP4, MPEG-TS, WebM/Matroska,
raw elementary streams, WebVTT/TTML) and writes CMAF init + media segments plus
DASH and/or HLS manifests into an output directory — the library form of the
sheathe package CLI command.
Multiple inputs form an ABR ladder by default (each input’s track(s) become
separate renditions sharing one period). With PackageOptions::multi_period
each input becomes a successive DASH Period instead.
Phase 4 (live & advanced manifests) is controlled via
PresentationMode, live window size, trick-play, low-latency parts, and
SCTE-35 markers.
Phase 5 adds on-demand single-file DASH, packed-audio / MPEG-TS HLS, IO backends, JIT origin, and multi-track parallelism.
Re-exports§
pub use descriptor::StreamDescriptor;pub use descriptor::StreamSelector;pub use descriptor::parse_descriptor;pub use descriptor::parse_input_arg;pub use io::FileSink;pub use io::HttpPushSink;pub use io::ObjectSink;pub use io::read_input;pub use knobs::ClosedCaption;pub use knobs::CpixConfig;pub use knobs::LabeledKey;pub use knobs::PackageKnobs;pub use knobs::WidevineConfig;pub use origin::OriginConfig;pub use origin::serve as serve_origin;
Modules§
- descriptor
- Shaka-style stream descriptors (
in=file,stream=audio,language=eng,…). - io
- Output sinks and input sources for packaging (Phase 5 IO backends).
- knobs
- Extra packaging knobs that map 1:1 onto Shaka Packager flags.
- origin
- JIT / origin mode — package on HTTP request (Phase 5).
Structs§
- Encryption
Spec - Raw-key content encryption for a
packagerun. - Http
Options - TLS / HTTP options for push, CPIX, and Widevine.
- Package
Options - Options controlling a
packagerun. - Package
Output - What a
packagerun produced. - Probe
Report - Result of
probe: the detected container and its streams. - Probe
Stream - One stream discovered by
probe. - Scte35
Marker - A SCTE-35 cue placement relative to the presentation timeline.
Enums§
- DrmSystem
- A DRM protection system a
psshbox can be generated for. - EncScheme
- A CENC protection scheme (the
schmscheme_type). - Presentation
Mode - How the presentation should be signalled in DASH/HLS manifests.
- Segment
Format - Container / segment format for packaged media.
Functions§
- build_
splice_ insert - Build a binary SCTE-35
splice_info_sectionformarker. - describe
- One-line human description of a stream (re-exported for CLI/probe use).
- dump_
stream - Multi-line dump of one probed stream, modelled on Shaka Packager
--dump_stream_info. - package
- Package one or more inputs into CMAF segments + DASH and/or HLS manifests under
opts.out_dir. - probe
- Inspect an input and report the container + streams sheathe detects, without
writing anything. The library form of the
sheathe probeCLI command. - scheme_
str - Human-readable name for a
Scheme(matches the CLI/DASH spelling). - to_
base64 - Standard base64 (no padding strip) for DASH Event message data.
- to_
hex_ 0x - Hex encoding with a
0xprefix (HLSSCTE35-OUTstyle).