Class AsciinemaRepresentation

Representation class for the Asciinema specification

Inheritance

object

AsciinemaRepresentation

Namespace: Terminaux.Writer.CyclicWriters.Renderer.Tools

Assembly: Terminaux.dll

Syntax

public class AsciinemaRepresentation

Properties

Asciicast

Asciicast recording instance

Declaration

public Asciicast Asciicast { get; }

Property Value

Type	Description
Asciicast

Height

Initial console height

Declaration

[JsonIgnore]
public int Height { get; }

Property Value

Type	Description
int

Version

Asciicast version

Declaration

[JsonIgnore]
public int Version { get; }

Property Value

Type	Description
int

Width

Initial console width

Declaration

[JsonIgnore]
public int Width { get; }

Property Value

Type	Description
int

Methods

GetRepresentationFromContents(string)

Gets the Asciinema representation from the contents

Declaration

public static AsciinemaRepresentation GetRepresentationFromContents(string asciiCastContents)

Parameters

Type	Name	Description
string	asciiCastContents	Contents

Returns

Type	Description
AsciinemaRepresentation	A representation of the Asciinema recording

Exceptions

Type	Condition
TerminauxException

GetRepresentationFromFile(string)

Gets the Asciinema representation from the file

Declaration

public static AsciinemaRepresentation GetRepresentationFromFile(string fileName)

Parameters

Type	Name	Description
string	fileName	File name to parse

Returns

Type	Description
AsciinemaRepresentation	A representation of the Asciinema recording

Exceptions

Type	Condition
TerminauxException

GetRepresentationFromStream(Stream)

Gets the Asciinema representation from the stream

Declaration

public static AsciinemaRepresentation GetRepresentationFromStream(Stream asciiCastStream)

Parameters

Type	Name	Description
Stream	asciiCastStream	Stream containing Asciinema represetation

Returns

Type	Description
AsciinemaRepresentation	A representation of the Asciinema recording

Exceptions

Type	Condition
TerminauxException