Table of Contents

Class ClosedCaptions

Namespace
ValveResourceFormat.ClosedCaptions
Assembly
ValveResourceFormat.dll

Represents a collection of closed captions from a VCCD file.

public class ClosedCaptions : IEnumerable<ClosedCaption>, IEnumerable

Inheritance

Implements

Inherited Members

Fields

MAGIC

Magic number for VCCD files ("VCCD").

public const int MAGIC = 1145258838

Field Value

int

Properties

Captions

Gets the list of captions.

public List<ClosedCaption> Captions { get; }

Property Value

List<ClosedCaption>

this[string]

Gets a caption by its key.

public ClosedCaption this[string key] { get; }

Property Value

ClosedCaption

Methods

GetEnumerator()

Returns an enumerator that iterates through the captions.

public IEnumerator<ClosedCaption> GetEnumerator()

Returns

IEnumerator<ClosedCaption>

Read(string)

Opens the specified file and reads all caption entries into memory.

public void Read(string filename)

Parameters

filename string

The file to open and read.

Read(string, Stream)

Reads caption data from the provided stream.

public void Read(string filename, Stream input)

Parameters

filename string

The name of the caption file (used for metadata only).

input Stream

The input System.IO.Stream to read from.

ToString()

Returns a string that represents the current object.

public override string ToString()

Returns

string

A string that represents the current object.

Remarks

Exports the captions to KeyValues1 text format (VCD format).