Class AsciinemaRepresentation

Representation class for the Asciinema specification

Inheritance

object

AsciinemaRepresentation

Namespace

Terminaux.Writer.CyclicWriters.Renderer.Tools @ Terminaux.dll

Syntax

public class AsciinemaRepresentation

Properties

Asciicast

Asciicast recording instance

Property Value

Asciicast

Declaration

public Asciicast Asciicast { get; }

Height

Initial console height

Property Value

int

Declaration

[JsonIgnore]
public int Height { get; }

Version

Asciicast version

Property Value

int

Declaration

[JsonIgnore]
public int Version { get; }

Width

Initial console width

Property Value

int

Declaration

[JsonIgnore]
public int Width { get; }

Methods

GetRepresentationFromContents(string)

Gets the Asciinema representation from the contents

Returns

AsciinemaRepresentation

A representation of the Asciinema recording

Declaration

public static AsciinemaRepresentation GetRepresentationFromContents(string asciiCastContents)

Parameters

Name	Type	Description
asciiCastContents	string	Contents

Exceptions

Type	Condition
TerminauxException

GetRepresentationFromFile(string)

Gets the Asciinema representation from the file

Returns

AsciinemaRepresentation

A representation of the Asciinema recording

Declaration

public static AsciinemaRepresentation GetRepresentationFromFile(string fileName)

Parameters

Name	Type	Description
fileName	string	File name to parse

Exceptions

Type	Condition
TerminauxException

GetRepresentationFromStream(Stream)

Gets the Asciinema representation from the stream

Returns

AsciinemaRepresentation

A representation of the Asciinema recording

Declaration

public static AsciinemaRepresentation GetRepresentationFromStream(Stream asciiCastStream)

Parameters

Name	Type	Description
asciiCastStream	Stream	Stream containing Asciinema represetation

Exceptions

Type	Condition
TerminauxException