shaka::media::BufferWriter Class Reference

#include <buffer_writer.h>

Public Member Functions
	BufferWriter (size_t reserved_size_in_bytes)
void	AppendNBytes (uint64_t v, size_t num_bytes)
void	AppendVector (const std::vector< uint8_t > &v)
void	AppendString (const std::string &s)
void	AppendArray (const uint8_t *buf, size_t size)
void	AppendBuffer (const BufferWriter &buffer)
void	Swap (BufferWriter *buffer)
void	SwapBuffer (std::vector< uint8_t > *buffer)
void	Clear ()
size_t	Size () const
const uint8_t *	Buffer () const
Status	WriteToFile (File *file)
void	AppendInt (uint8_t v)
void	AppendInt (uint16_t v)
void	AppendInt (uint32_t v)
void	AppendInt (uint64_t v)
void	AppendInt (int16_t v)
void	AppendInt (int32_t v)
void	AppendInt (int64_t v)

Detailed Description

A simple buffer writer implementation which appends various data types to buffer.

Definition at line 24 of file buffer_writer.h.

Constructor & Destructor Documentation

BufferWriter() [1/2]

shaka::media::BufferWriter::BufferWriter

(

)

Definition at line 18 of file buffer_writer.cc.

BufferWriter() [2/2]

shaka::media::BufferWriter::BufferWriter ( size_t  reserved_size_in_bytes )

explicit

Construct the object with a reserved capacity.

Parameters

reserved_size_in_bytes

is intended for optimization and is not a hard limit. It does not affect the actual size of the buffer, which still starts from zero.

Definition at line 22 of file buffer_writer.cc.

~BufferWriter()

shaka::media::BufferWriter::~BufferWriter

(

)

Definition at line 25 of file buffer_writer.cc.

Member Function Documentation

AppendArray()

void shaka::media::BufferWriter::AppendArray	(	const uint8_t *	buf,
		size_t	size
	)

Definition at line 64 of file buffer_writer.cc.

AppendBuffer()

void shaka::media::BufferWriter::AppendBuffer

(

const BufferWriter &

buffer

)

Definition at line 68 of file buffer_writer.cc.

AppendInt() [1/7]

void shaka::media::BufferWriter::AppendInt

(

int16_t

v

)

Definition at line 39 of file buffer_writer.cc.

AppendInt() [2/7]

void shaka::media::BufferWriter::AppendInt

(

int32_t

v

)

Definition at line 42 of file buffer_writer.cc.

AppendInt() [3/7]

void shaka::media::BufferWriter::AppendInt

(

int64_t

v

)

Definition at line 45 of file buffer_writer.cc.

AppendInt() [4/7]

void shaka::media::BufferWriter::AppendInt

(

uint16_t

v

)

Definition at line 30 of file buffer_writer.cc.

AppendInt() [5/7]

void shaka::media::BufferWriter::AppendInt

(

uint32_t

v

)

Definition at line 33 of file buffer_writer.cc.

AppendInt() [6/7]

void shaka::media::BufferWriter::AppendInt

(

uint64_t

v

)

Definition at line 36 of file buffer_writer.cc.

AppendInt() [7/7]

void shaka::media::BufferWriter::AppendInt

(

uint8_t

v

)

These convenience functions append the integers (in network byte order, i.e. big endian) of various size and signedness to the end of the buffer.

Definition at line 27 of file buffer_writer.cc.

AppendNBytes()

void shaka::media::BufferWriter::AppendNBytes	(	uint64_t	v,
		size_t	num_bytes
	)

Append the least significant num_bytes of v to buffer.

Parameters

num_bytes

should not be larger than sizeof(v), i.e. 8 on a 64-bit system.

Definition at line 49 of file buffer_writer.cc.

AppendString()

void shaka::media::BufferWriter::AppendString

(

const std::string &

s

)

Definition at line 60 of file buffer_writer.cc.

AppendVector()

void shaka::media::BufferWriter::AppendVector

(

const std::vector< uint8_t > &

v

)

Definition at line 56 of file buffer_writer.cc.

Buffer()

const uint8_t * shaka::media::BufferWriter::Buffer ( ) const

inline

Returns

Underlying buffer. Behavior is undefined if the buffer size is 0.

Definition at line 62 of file buffer_writer.h.

Clear()

void shaka::media::BufferWriter::Clear ( )

inline

Definition at line 59 of file buffer_writer.h.

Size()

size_t shaka::media::BufferWriter::Size ( ) const

inline

Definition at line 60 of file buffer_writer.h.

Swap()

void shaka::media::BufferWriter::Swap ( BufferWriter *  buffer )

inline

Definition at line 56 of file buffer_writer.h.

SwapBuffer()

void shaka::media::BufferWriter::SwapBuffer ( std::vector< uint8_t > *  buffer )

inline

Definition at line 57 of file buffer_writer.h.

WriteToFile()

Status shaka::media::BufferWriter::WriteToFile

(

File *

file

)

Write the buffer to file. The internal buffer will be cleared after writing.

Parameters

file	should not be NULL.

Returns

OK on success.

Definition at line 72 of file buffer_writer.cc.

---

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

• packager/media/base/buffer_writer.h
• packager/media/base/buffer_writer.cc