asciicast

Documentation

Index

• func Save(asciicast *Asciicast, path string) error
• type Asciicast
  • func Load(url string) (*Asciicast, error)
  • func NewAsciicast(width, height int, duration float64, command, title string, frames []Frame, ...) *Asciicast
• type AsciicastPlayer
  • func (r *AsciicastPlayer) Play(asciicast *Asciicast, maxWait uint) error
• type AsciicastRecorder
  • func (r *AsciicastRecorder) Record(path, command, title string, maxWait uint, assumeYes bool, ...) error
• type Duration
  • func (d Duration) MarshalJSON() ([]byte, error)
• type Env
• type Frame
  • func (f *Frame) MarshalJSON() ([]byte, error)
  • func (f *Frame) UnmarshalJSON(data []byte) error
• type Player
  • func NewPlayer() Player
• type Recorder
  • func NewRecorder() Recorder
• type Stream
  • func NewStream(maxWait uint) *Stream
  • func (s *Stream) Close()
  • func (s *Stream) Duration() time.Duration
  • func (s *Stream) Write(p []byte) (int, error)

Functions

func Save

func Save(asciicast *Asciicast, path string) error

Types

type Asciicast

type Asciicast struct {
	Version  int      `json:"version"`
	Width    int      `json:"width"`
	Height   int      `json:"height"`
	Duration Duration `json:"duration"`
	Command  string   `json:"command"`
	Title    string   `json:"title"`
	Env      *Env     `json:"env"`
	Stdout   []Frame  `json:"stdout"`
}

func Load

func Load(url string) (*Asciicast, error)

func NewAsciicast

func NewAsciicast(width, height int, duration float64, command, title string, frames []Frame, env map[string]string) *Asciicast

type AsciicastPlayer

type AsciicastPlayer struct {
	Terminal terminal.Terminal
}

func (*AsciicastPlayer) Play

func (r *AsciicastPlayer) Play(asciicast *Asciicast, maxWait uint) error

type AsciicastRecorder

type AsciicastRecorder struct {
	Terminal terminal.Terminal
}

func (*AsciicastRecorder) Record

func (r *AsciicastRecorder) Record(path, command, title string, maxWait uint, assumeYes bool, env map[string]string) error

type Duration

type Duration float64

func (Duration) MarshalJSON

func (d Duration) MarshalJSON() ([]byte, error)

type Env

type Env struct {
	Term  string `json:"TERM"`
	Shell string `json:"SHELL"`
}

type Frame

type Frame struct {
	Delay float64
	Data  []byte
}

func (*Frame) MarshalJSON

func (f *Frame) MarshalJSON() ([]byte, error)

func (*Frame) UnmarshalJSON

func (f *Frame) UnmarshalJSON(data []byte) error

type Player

type Player interface {
	Play(*Asciicast, uint) error
}

func NewPlayer

func NewPlayer() Player

type Recorder

type Recorder interface {
	Record(string, string, string, uint, bool, map[string]string) error
}

func NewRecorder

func NewRecorder() Recorder

type Stream

type Stream struct {
	Frames []Frame
	// contains filtered or unexported fields
}

func NewStream

func NewStream(maxWait uint) *Stream

func (*Stream) Close

func (s *Stream) Close()

func (*Stream) Duration

func (s *Stream) Duration() time.Duration

func (*Stream) Write

func (s *Stream) Write(p []byte) (int, error)