DASH Media Packaging SDK
 All Classes Namespaces Functions Variables Typedefs Enumerator
Public Member Functions | List of all members
edash_packager::MpdNotifier Class Referenceabstract

#include <mpd_notifier.h>

Inheritance diagram for edash_packager::MpdNotifier:
edash_packager::DashIopMpdNotifier edash_packager::MockMpdNotifier edash_packager::SimpleMpdNotifier

Public Member Functions

 MpdNotifier (DashProfile dash_profile)
 
virtual bool Init ()=0
 
virtual bool NotifyNewContainer (const MediaInfo &media_info, uint32_t *container_id)=0
 
virtual bool NotifySampleDuration (uint32_t container_id, uint32_t sample_duration)=0
 
virtual bool NotifyNewSegment (uint32_t container_id, uint64_t start_time, uint64_t duration, uint64_t size)=0
 
virtual bool NotifyEncryptionUpdate (uint32_t container_id, const std::string &drm_uuid, const std::vector< uint8_t > &new_key_id, const std::vector< uint8_t > &new_pssh)=0
 
virtual bool AddContentProtectionElement (uint32_t container_id, const ContentProtectionElement &content_protection_element)=0
 
virtual bool Flush ()=0
 
DashProfile dash_profile () const
 

Detailed Description

Interface for publish/subscribe publisher class which notifies MpdBuilder of media-related events.

Definition at line 32 of file mpd_notifier.h.

Member Function Documentation

virtual bool edash_packager::MpdNotifier::AddContentProtectionElement ( uint32_t  container_id,
const ContentProtectionElement content_protection_element 
)
pure virtual

Adds content protection information to the MPD.

Parameters
container_idis the nummeric container ID obtained from calling NotifyNewContainer().
content_protection_elementNew ContentProtection element specification.
Returns
true on success, false otherwise.

Implemented in edash_packager::SimpleMpdNotifier, and edash_packager::DashIopMpdNotifier.

DashProfile edash_packager::MpdNotifier::dash_profile ( ) const
inline
Returns
The dash profile for this object.

Definition at line 108 of file mpd_notifier.h.

virtual bool edash_packager::MpdNotifier::Flush ( )
pure virtual

Call this method to force a flush. Implementations might not write out the MPD to a stream (file, stdout, etc.) when the MPD is updated, this forces a flush.

Implemented in edash_packager::SimpleMpdNotifier, and edash_packager::DashIopMpdNotifier.

virtual bool edash_packager::MpdNotifier::Init ( )
pure virtual

Initializes the notifier. For example, if this notifier uses a network for notification, then this would set up the connection with the remote host.

Returns
true on success, false otherwise.

Implemented in edash_packager::SimpleMpdNotifier, and edash_packager::DashIopMpdNotifier.

virtual bool edash_packager::MpdNotifier::NotifyEncryptionUpdate ( uint32_t  container_id,
const std::string &  drm_uuid,
const std::vector< uint8_t > &  new_key_id,
const std::vector< uint8_t > &  new_pssh 
)
pure virtual

Notifiers MpdBuilder that there is a new PSSH for the container. This may be called whenever the key has to change, e.g. key rotation.

Parameters
container_idContainer ID obtained from calling NotifyNewContainer().
drm_uuidis the UUID of the DRM for encryption.
new_key_idis the new key ID for the key.
new_psshis the new pssh box (including the header).
Attention
This might change or get removed once DASH IF IOP specification writes a clear guideline on how to handle key rotation.

Implemented in edash_packager::SimpleMpdNotifier, and edash_packager::DashIopMpdNotifier.

virtual bool edash_packager::MpdNotifier::NotifyNewContainer ( const MediaInfo &  media_info,
uint32_t *  container_id 
)
pure virtual

Notifies the MpdBuilder that there is a new container along with media_info. Live may have multiple files (segments) but those should be notified via NotifyNewSegment().

Parameters
media_infois the MediaInfo that will be passed to MpdBuilder.
[out]container_idis the numeric ID of the container, possibly for NotifyNewSegment() and AddContentProtectionElement(). Only populated on success.
Returns
true on success, false otherwise.

Implemented in edash_packager::SimpleMpdNotifier, and edash_packager::DashIopMpdNotifier.

virtual bool edash_packager::MpdNotifier::NotifyNewSegment ( uint32_t  container_id,
uint64_t  start_time,
uint64_t  duration,
uint64_t  size 
)
pure virtual

Notifies MpdBuilder that there is a new segment ready. For live, this is usually a new segment, for VOD this is usually a subsegment.

Parameters
container_idContainer ID obtained from calling NotifyNewContainer().
start_timeis the start time of the new segment, in units of the stream's time scale.
durationis the duration of the new segment, in units of the stream's time scale.
sizeis the new segment size in bytes.
Returns
true on success, false otherwise.

Implemented in edash_packager::SimpleMpdNotifier, and edash_packager::DashIopMpdNotifier.

virtual bool edash_packager::MpdNotifier::NotifySampleDuration ( uint32_t  container_id,
uint32_t  sample_duration 
)
pure virtual

Change the sample duration of container with container_id.

Parameters
container_idContainer ID obtained from calling NotifyNewContainer().
sample_durationis the duration of a sample in timescale of the media.
Returns
true on success, false otherwise. This may fail if the container specified by container_id does not exist.

Implemented in edash_packager::SimpleMpdNotifier, and edash_packager::DashIopMpdNotifier.


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