asciicast

Documentation

Overview

Package asciicast provides methods for working with asciinema's file format asciicast v2.

Refer to the official documentation about asciicast v2 format here: https://github.com/asciinema/asciinema/blob/develop/doc/asciicast-v2.md

Index

• Constants
• type Cast
  • func New() *Cast
  • func Unmarshal(data []byte) (*Cast, error)
  • func (c *Cast) AdjustSpeed(speed float64)
  • func (c *Cast) CapRelativeTime(limit float64)
  • func (c *Cast) Compress()
  • func (c *Cast) Marshal() ([]byte, error)
  • func (c *Cast) ToAbsoluteTime()
  • func (c *Cast) ToRelativeTime()
• type Event
  • func (e *Event) MarshalJSON() ([]byte, error)
  • func (e *Event) UnmarshalJSON(data []byte) error

Constants

const (
	Input  eventType = "i" // Data read from stdin.
	Output eventType = "o" // Data writed to stdout.
)

Types

type Cast

type Cast struct {
	Header header
	Events []Event
}

Cast contains asciicast file data

func New

func New() *Cast

New will instantiate new Cast with basic medatada (version, timestamp and environment).

func Unmarshal

func Unmarshal(data []byte) (*Cast, error)

Unmarshal parses the JSON-encoded data into a Cast struct.

func (*Cast) AdjustSpeed

func (c *Cast) AdjustSpeed(speed float64)

AdjustSpeed changes the time of each event. Slower < 1.0 > Faster.

func (*Cast) CapRelativeTime

func (c *Cast) CapRelativeTime(limit float64)

CapRelativeTime limits the amount of time between each event

func (*Cast) Compress

func (c *Cast) Compress()

Compress chains together events with the same time.

func (*Cast) Marshal

func (c *Cast) Marshal() ([]byte, error)

Marshal returns the JSON-like encoding of v.

func (*Cast) ToAbsoluteTime

func (c *Cast) ToAbsoluteTime()

ToAbsoluteTime converts event time to the absolute difference from the start. This is the default time format.

func (*Cast) ToRelativeTime

func (c *Cast) ToRelativeTime()

ToRelativeTime converts event time to the difference between each event.

type Event

type Event struct {
	Time      float64   `json:"time"`
	EventType eventType `json:"event-type"`
	EventData string    `json:"event-data"`
}

Event is a 3-tuple encoded as JSON array.

func (*Event) MarshalJSON

func (e *Event) MarshalJSON() ([]byte, error)

MarshalJSON reads json list as Event fields.

func (*Event) UnmarshalJSON

func (e *Event) UnmarshalJSON(data []byte) error

UnmarshalJSON reads json list as Event fields.