libdcp
Public Member Functions | Protected Attributes | Private Member Functions | Friends | List of all members
dcp::ReelSubtitleAsset Class Reference

Part of a Reel's description which refers to a subtitle XML/MXF file. More...

#include <reel_subtitle_asset.h>

Inheritance diagram for dcp::ReelSubtitleAsset:
dcp::ReelFileAsset dcp::ReelAsset dcp::Object dcp::ReelInteropSubtitleAsset dcp::ReelSMPTESubtitleAsset

Public Member Functions

 ReelSubtitleAsset (std::shared_ptr< SubtitleAsset > asset, Fraction edit_rate, int64_t intrinsic_duration, int64_t entry_point)
 
 ReelSubtitleAsset (std::shared_ptr< const cxml::Node >)
 
std::shared_ptr< const SubtitleAssetasset () const
 
std::shared_ptr< SubtitleAssetasset ()
 
xmlpp::Node * write_to_cpl (xmlpp::Node *node, Standard standard) const override
 
bool equals (std::shared_ptr< const ReelSubtitleAsset >, EqualityOptions, NoteHandler) const
 
void set_language (dcp::LanguageTag language)
 
boost::optional< std::string > language () const
 
- Public Member Functions inherited from dcp::ReelFileAsset
 ReelFileAsset (std::shared_ptr< Asset > asset, boost::optional< std::string > key_id, std::string id, Fraction edit_rate, int64_t intrinsic_duration, int64_t entry_point)
 
 ReelFileAsset (std::shared_ptr< const cxml::Node > node)
 
Ref const & asset_ref () const
 
Refasset_ref ()
 
boost::optional< std::string > hash () const
 
void set_hash (std::string h)
 
bool file_asset_equals (std::shared_ptr< const ReelFileAsset > other, EqualityOptions opt, NoteHandler note) const
 
virtual boost::optional< std::string > key_type () const
 
bool encryptable () const override
 
boost::optional< std::string > key_id () const
 
bool encrypted () const
 
- Public Member Functions inherited from dcp::ReelAsset
 ReelAsset (std::string id, Fraction edit_rate, int64_t intrinsic_duration, int64_t entry_point)
 
 ReelAsset (std::shared_ptr< const cxml::Node >)
 
Fraction edit_rate () const
 
int64_t intrinsic_duration () const
 
void set_entry_point (int64_t e)
 
void unset_entry_point ()
 
boost::optional< int64_t > entry_point () const
 
void set_duration (int64_t d)
 
boost::optional< int64_t > duration () const
 
int64_t actual_duration () const
 
boost::optional< std::string > annotation_text () const
 
void set_annotation_text (std::string at)
 
void unset_annotation_text ()
 
bool asset_equals (std::shared_ptr< const ReelAsset >, EqualityOptions, NoteHandler) const
 
- Public Member Functions inherited from dcp::Object
 Object ()
 
 Object (std::string id)
 
 Object (Object const &)=delete
 
Objectoperator= (Object const &)=delete
 
std::string id () const
 

Protected Attributes

boost::optional< std::string > _language
 
- Protected Attributes inherited from dcp::ReelFileAsset
Ref _asset_ref
 
boost::optional< std::string > _hash
 
boost::optional< std::string > _key_id
 The <KeyId> from the reel's entry for this asset, if there is one.
 
- Protected Attributes inherited from dcp::ReelAsset
int64_t _intrinsic_duration = 0
 The <IntrinsicDuration> from the reel's entry for this asset.
 
boost::optional< int64_t > _duration
 The <Duration> from the reel's entry for this asset, if present.
 
- Protected Attributes inherited from dcp::Object
std::string _id
 

Private Member Functions

std::string cpl_node_name (Standard standard) const override
 

Friends

struct ::verify_invalid_language1
 

Additional Inherited Members

- Protected Member Functions inherited from dcp::ReelFileAsset
template<class T >
std::shared_ptr< T > asset_of_type () const
 
template<class T >
std::shared_ptr< T > asset_of_type ()
 
- Protected Member Functions inherited from dcp::ReelAsset
virtual std::pair< std::string, std::string > cpl_node_attribute (Standard) const
 
virtual std::pair< std::string, std::string > cpl_node_namespace () const
 

Detailed Description

Part of a Reel's description which refers to a subtitle XML/MXF file.

Definition at line 62 of file reel_subtitle_asset.h.

Member Function Documentation

◆ cpl_node_name()

string ReelSubtitleAsset::cpl_node_name ( Standard  ) const
overrideprivatevirtual
Returns
the node name that this asset uses in the CPL's <Reel> node e.g. MainPicture, MainSound etc.

Implements dcp::ReelAsset.

Definition at line 79 of file reel_subtitle_asset.cc.

Member Data Documentation

◆ _language

boost::optional<std::string> dcp::ReelSubtitleAsset::_language
protected

As in other places, this is stored and returned as a string so that we can tolerate non-RFC-5646 strings, but must be set as a dcp::LanguageTag to try to ensure that we create compliant output.

Definition at line 91 of file reel_subtitle_asset.h.


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