Class: Coradoc::AsciiDoc::Model::Video

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

Overview

Video block element for AsciiDoc documents.

Videos are embedded multimedia content with support for various video platforms and custom attributes.

Examples:

Create a video block

video = Coradoc::AsciiDoc::Model::Video.new
video.src = "https://example.com/video.mp4"
video.title = "Demo Video"

Defined Under Namespace

Classes: AttributeList

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::Video::AttributeList (readonly)

Returns Video-specific attributes.

Returns:



31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
 
# File 'lib/coradoc/asciidoc/model/video.rb', line 31

class Video < Base
  # Autoload nested AttributeList class
  autoload :AttributeList, 'coradoc/asciidoc/model/video/attribute_list'

  include Coradoc::AsciiDoc::Model::Anchorable

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

#id ⇒ String? (readonly)

Returns Optional identifier for the video.

Returns:

  • (String, nil) —

    Optional identifier for the video



31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
 
# File 'lib/coradoc/asciidoc/model/video.rb', line 31

class Video < Base
  # Autoload nested AttributeList class
  autoload :AttributeList, 'coradoc/asciidoc/model/video/attribute_list'

  include Coradoc::AsciiDoc::Model::Anchorable

  attribute :id, :string
  attribute :title, :string
  attribute :src, :string, default: -> { '' }
  attribute :attributes,
            Video::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
42
43
44
45
46
 
# File 'lib/coradoc/asciidoc/model/video.rb', line 31

class Video < Base
  # Autoload nested AttributeList class
  autoload :AttributeList, 'coradoc/asciidoc/model/video/attribute_list'

  include Coradoc::AsciiDoc::Model::Anchorable

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

#src ⇒ String (readonly)

Returns The video source URL or path.

Returns:

  • (String) —

    The video source URL or path



31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
 
# File 'lib/coradoc/asciidoc/model/video.rb', line 31

class Video < Base
  # Autoload nested AttributeList class
  autoload :AttributeList, 'coradoc/asciidoc/model/video/attribute_list'

  include Coradoc::AsciiDoc::Model::Anchorable

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

#title ⇒ String? (readonly)

Returns Optional video title.

Returns:

  • (String, nil) —

    Optional video title



31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
 
# File 'lib/coradoc/asciidoc/model/video.rb', line 31

class Video < Base
  # Autoload nested AttributeList class
  autoload :AttributeList, 'coradoc/asciidoc/model/video/attribute_list'

  include Coradoc::AsciiDoc::Model::Anchorable

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