Shaka Packager SDK
Public Member Functions | List of all members
shaka::media::TextMuxer Class Referenceabstract

#include <text_muxer.h>

Inheritance diagram for shaka::media::TextMuxer:
shaka::media::Muxer shaka::media::MediaHandler shaka::media::ttml::TtmlMuxer shaka::media::webvtt::WebVttMuxer

Public Member Functions

 TextMuxer (const MuxerOptions &options)
 
- Public Member Functions inherited from shaka::media::Muxer
 Muxer (const MuxerOptions &options)
 
void Cancel ()
 
void SetMuxerListener (std::unique_ptr< MuxerListener > muxer_listener)
 
void SetProgressListener (std::unique_ptr< ProgressListener > progress_listener)
 
const std::vector< std::shared_ptr< const StreamInfo > > & streams () const
 
void set_clock (base::Clock *clock)
 
- Public Member Functions inherited from shaka::media::MediaHandler
Status SetHandler (size_t output_stream_index, std::shared_ptr< MediaHandler > handler)
 Connect downstream handler at the specified output stream index.
 
Status AddHandler (std::shared_ptr< MediaHandler > handler)
 Connect downstream handler to the next available output stream index.
 
Status Initialize ()
 
bool IsConnected ()
 Validate if the handler is connected to its upstream handler.
 

Additional Inherited Members

- Static Public Member Functions inherited from shaka::media::MediaHandler
static Status Chain (const std::vector< std::shared_ptr< MediaHandler >> &list)
 
- Protected Member Functions inherited from shaka::media::Muxer
const MuxerOptionsoptions () const
 
MuxerListenermuxer_listener ()
 
ProgressListenerprogress_listener ()
 
base::Clock * clock ()
 
Status InitializeInternal () override
 
Status Process (std::unique_ptr< StreamData > stream_data) override
 
Status OnFlushRequest (size_t input_stream_index) override
 Event handler for flush request at the specific input stream index.
 
- Protected Member Functions inherited from shaka::media::MediaHandler
virtual bool ValidateOutputStreamIndex (size_t stream_index) const
 Validate if the stream at the specified index actually exists.
 
Status Dispatch (std::unique_ptr< StreamData > stream_data) const
 
Status DispatchStreamInfo (size_t stream_index, std::shared_ptr< const StreamInfo > stream_info) const
 Dispatch the stream info to downstream handlers.
 
Status DispatchMediaSample (size_t stream_index, std::shared_ptr< const MediaSample > media_sample) const
 Dispatch the media sample to downstream handlers.
 
Status DispatchTextSample (size_t stream_index, std::shared_ptr< const TextSample > text_sample) const
 Dispatch the text sample to downstream handlers.
 
Status DispatchSegmentInfo (size_t stream_index, std::shared_ptr< const SegmentInfo > segment_info) const
 Dispatch the segment info to downstream handlers.
 
Status DispatchScte35Event (size_t stream_index, std::shared_ptr< const Scte35Event > scte35_event) const
 Dispatch the scte35 event to downstream handlers.
 
Status DispatchCueEvent (size_t stream_index, std::shared_ptr< const CueEvent > cue_event) const
 Dispatch the cue event to downstream handlers.
 
Status FlushDownstream (size_t output_stream_index)
 Flush the downstream connected at the specified output stream index.
 
Status FlushAllDownstreams ()
 Flush all connected downstream handlers.
 
bool initialized ()
 
size_t num_input_streams () const
 
size_t next_output_stream_index () const
 
const std::map< size_t, std::pair< std::shared_ptr< MediaHandler >, size_t > > & output_handlers ()
 

Detailed Description

Defines a base class for text format (i.e. not MP4) muxers. This handles separating the single-segment and multi-segment modes. Derived classes are expected to buffer cues (or text) and write them out in WriteToFile.

Definition at line 20 of file text_muxer.h.


The documentation for this class was generated from the following files: