Class: Coradoc::AsciiDoc::Model::Audio

Inherits:
Base
  • Object
show all
Includes:
Anchorable
Defined in:
lib/coradoc/asciidoc/model/audio.rb

Overview

Audio block element for AsciiDoc documents.

Audio elements are embedded multimedia content with support for various audio formats and custom attributes.

Examples:

Create an audio block

audio = Coradoc::AsciiDoc::Model::Audio.new
audio.src = "https://example.com/audio.mp3"
audio.title = "Podcast Episode"

Instance Attribute Summary collapse

Method Summary

Methods included from Anchorable

#default_anchor, #gen_anchor, included, #initialize

Methods inherited from Base

#block_level?, #inline?, #serialize_content, #simplify_block_content, #to_adoc, #to_h, visit, #visit

Instance Attribute Details

#attributes ⇒ Coradoc::AsciiDoc::Model::AttributeList (readonly)

Returns Audio attributes.

Returns:



31
32
33
34
35
36
37
38
39
40
41
 
# File 'lib/coradoc/asciidoc/model/audio.rb', line 31

class Audio < Base
  include Coradoc::AsciiDoc::Model::Anchorable

  attribute :id, :string
  attribute :title, :string
  attribute :src, :string, default: -> { '' }
  attribute :attributes, Coradoc::AsciiDoc::Model::AttributeList, default: lambda {
    Coradoc::AsciiDoc::Model::AttributeList.new
  }
  attribute :line_break, :string, default: -> { "\n" }
end

#id ⇒ String? (readonly)

Returns Optional identifier for the audio.

Returns:

  • (String, nil) —

    Optional identifier for the audio



31
32
33
34
35
36
37
38
39
40
41
 
# File 'lib/coradoc/asciidoc/model/audio.rb', line 31

class Audio < Base
  include Coradoc::AsciiDoc::Model::Anchorable

  attribute :id, :string
  attribute :title, :string
  attribute :src, :string, default: -> { '' }
  attribute :attributes, Coradoc::AsciiDoc::Model::AttributeList, default: lambda {
    Coradoc::AsciiDoc::Model::AttributeList.new
  }
  attribute :line_break, :string, default: -> { "\n" }
end

#line_break ⇒ String (readonly)

Returns Line break character (default: “n”).

Returns:

  • (String) —

    Line break character (default: “n”)



31
32
33
34
35
36
37
38
39
40
41
 
# File 'lib/coradoc/asciidoc/model/audio.rb', line 31

class Audio < Base
  include Coradoc::AsciiDoc::Model::Anchorable

  attribute :id, :string
  attribute :title, :string
  attribute :src, :string, default: -> { '' }
  attribute :attributes, Coradoc::AsciiDoc::Model::AttributeList, default: lambda {
    Coradoc::AsciiDoc::Model::AttributeList.new
  }
  attribute :line_break, :string, default: -> { "\n" }
end

#src ⇒ String (readonly)

Returns The audio source URL or path.

Returns:

  • (String) —

    The audio source URL or path



31
32
33
34
35
36
37
38
39
40
41
 
# File 'lib/coradoc/asciidoc/model/audio.rb', line 31

class Audio < Base
  include Coradoc::AsciiDoc::Model::Anchorable

  attribute :id, :string
  attribute :title, :string
  attribute :src, :string, default: -> { '' }
  attribute :attributes, Coradoc::AsciiDoc::Model::AttributeList, default: lambda {
    Coradoc::AsciiDoc::Model::AttributeList.new
  }
  attribute :line_break, :string, default: -> { "\n" }
end

#title ⇒ String? (readonly)

Returns Optional audio title.

Returns:

  • (String, nil) —

    Optional audio title



31
32
33
34
35
36
37
38
39
40
41
 
# File 'lib/coradoc/asciidoc/model/audio.rb', line 31

class Audio < Base
  include Coradoc::AsciiDoc::Model::Anchorable

  attribute :id, :string
  attribute :title, :string
  attribute :src, :string, default: -> { '' }
  attribute :attributes, Coradoc::AsciiDoc::Model::AttributeList, default: lambda {
    Coradoc::AsciiDoc::Model::AttributeList.new
  }
  attribute :line_break, :string, default: -> { "\n" }
end