Class: Animoto::Manifests::StoryboardUnbundling

Inherits:

Base

• Object
• Base
• Animoto::Manifests::StoryboardUnbundling

Defined in:

lib/animoto/manifests/storyboard_unbundling.rb

Instance Attribute Summary

• #bundle_url ⇒ String

  The URL to the storyboard bundle.

Attributes inherited from Base

#http_callback_format, #http_callback_url, #partner_metadata

Instance Method Summary

• #initialize(options = {}) ⇒ StoryboardUnbundling constructor

  Creates a new storyboard unbundling manifest Unbundling a storyboard “rehydrates” the assets and directorial decisions associated with this project, allowing the video to be rendered even if the original storyboard or visual assets have expired or been deleted on Animoto’s servers since they were created the first time.

• #to_hash ⇒ Hash{String=>Object}

  Returns a representation of this manifest as a Hash.

Methods inherited from Base

#associated_job_class, associated_job_class, infer_content_type

Methods included from Support::ContentType

included

Constructor Details

#initialize(options = {}) ⇒ StoryboardUnbundling

Creates a new storyboard unbundling manifest Unbundling a storyboard “rehydrates” the assets and directorial decisions associated with this project, allowing the video to be rendered even if the original storyboard or visual assets have expired or been deleted on Animoto’s servers since they were created the first time.

Parameters:

• options (Hash{Symbol=>Object}) (defaults to: {})

Options Hash (options):

• :bundle_url (String) —

  the URL pointing to a storyboard bundle

• :http_callback_url (String) —

  a URL to receive a callback when this job is done

• :http_callback_format (String) —

  the format of the callback

# File 'lib/animoto/manifests/storyboard_unbundling.rb', line 19

def initialize options = {}
  super
  @bundle_url = options[:bundle_url]
end

Instance Attribute Details

#bundle_url ⇒ String

The URL to the storyboard bundle

Returns:

• (String)

# File 'lib/animoto/manifests/storyboard_unbundling.rb', line 7

def bundle_url
  @bundle_url
end

Instance Method Details

#to_hash ⇒ Hash{String=>Object}

Returns a representation of this manifest as a Hash.

Returns:

• (Hash{String=>Object}) —

  this manifest as a Hash

Raises:

• (ArgumentError) —

  if a callback URL is specified but not the format

# File 'lib/animoto/manifests/storyboard_unbundling.rb', line 28

def to_hash
  hash  = { 'storyboard_unbundling_job' => { 'storyboard_unbundling_manifest' => {} } }
  job   = hash['storyboard_unbundling_job']
  add_callback_information job
  manifest = job['storyboard_unbundling_manifest']
  manifest['bundle_url'] = bundle_url
  hash
end