Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
A lightweight API for indexing metadata and links to existing derivatives into Avalon.  

...

Code Block
languageruby
title:files example
       [{label: "Part 1",
	  	title: "Part 1",
        files: [{label: 'quality-high',
                  id: 'track-1',
                  url: "https://streaming.server/path/to/high.m3u8",
                  duration: "6315",
                  mime_type:  "video/mp4",
                  audio_bitrate: "127716.0",
                  audio_codec: "AAC",
                  video_bitrate: "1000000.0",
                  video_codec: "AVC",
                  width: "640",
                  height: "480" },
                {label: 'quality-medium',
                  id: 'track-2',
                  url: "https://streaming.server/path/to/medium.m3u8",
                  duration: "6315",
                  mime_type: "video/mp4",
                  audio_bitrate: "127716.0",
                  audio_codec: "AAC",
                  video_bitrate: "1000000.0",
                  video_codec: "AVC",
                  width: "640",
                  height: "480" }
               ],
        file_location: "/srv/avalon/master_files/file.mp4",
        file_checksum: "7ae24368ccb7a6c6422a14ff73f33c9a",
        file_size: "199160",
        duration: "6315",
        display_aspect_ratio: "1.7777777777777777",
        original_frame_size: "640x480",
        file_format: "Moving image",
        poster_offset: "0:02",
        thumbnail_offset: "0:02",
        date_digitized: "2015-12-31",
        structure: structure xml,
        captions: captions text from vtt or srt file,
        captions_type: 'text/vtt' (or 'text/srt')
	        workflow_nameother_identifier: ["avalon40000000045312"],
        percent_completecomment: "100.0"["test comment"],
        percent_succeeded: "100.0",
        percent_failed: "0",
        status_code: "COMPLETED",
	    other_identifier: ["40000000045312"],
        comment: ["test comment"],
        structure: "<?structure: "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<!-- Music for Piano; http://server1.variations2.indiana.edu/variations/cgi-bin/access.pl?id=BFJ6801 -->\n<Item label=\"CD 1\">\n    <Div label=\"Copland, Three Piano Excerpts from Our Town\">\n        <Div<Span label=\"Copland,Track Three1. PianoStory Excerptsof from Our Town\" begin=\"0\" end=\"0:09.99\"/>\n        <Span label=\"Track 12. Conversation Storyat ofthe OurSoda TownFountain\" begin=\"0:10\" end=\"0:0919.99\"/>\n        <Span label=\"Track 23. The Resting ConversationPlace aton the Soda FountainHill\" begin=\"0:1020\" end=\"0:1929.99\"/>\n    </Div>\n    <Span<Div label=\"Track 3. The Resting Place on the HillCopland, Four Episodes from Rodeo\">\n        <Span label=\"Track 4. Buckaroo Holiday\" begin=\"0:2030\" end=\"0:2939.99\"/>\n    </Div>\n    <Div<Span label=\"Copland, Four Episodes from Rodeo\"Track 5. Corral Nocturne\" begin=\"0:40\" end=\"0:49.99\"/>\n        <Span label=\"Track 46. BuckarooSaturday Night HolidayWaltz\" begin=\"0:3050\" end=\"0:3959.99\"/>\n        <Span label=\"Track 57. Corral NocturneHoe-Down\" begin=\"01:4000\" end=\"01:4909.99\"/>\n    </Div>\n    <Span label=\"Track 68. Copland, SaturdayPiano NightVariations Waltz\" begin=\"1:10\" end=\"0:50\" end=\"0:59.99\"/1:19.99\"/>\n    <Div label=\"Copland, Four Piano Blues\">\n        <Span label=\"Track 7. Hoe-Down9. For Leo Smit: Freely poetic\" begin=\"1:0020\" end=\"1:0929.99\"/>\n    </Div>\n    <Span label=\"Track 810. Copland, Piano Variations  For Andor Foldes: Soft and languid\" begin=\"1:1030\" end=\"1:1939.99\"/>\n    <Div label=\"Copland, Four Piano Blues\">\n        <Span label=\"Track 911. For LeoWillian SmitKapell: FreelyMuted and poeticsensuous\" begin=\"1:2040\" end=\"1:2949.99\"/>\n        <Span label=\"Track 1012. For AndorJohn FoldesKirkpatrick: SoftWIth and languidbounce\" begin=\"1:3050\" end=\"1:3959.99\"/>\n    </Div>\n    <Span label=\"Track 1113. ForCopland, Willian Kapell: Muted and sensuousDanzon Cubano\" begin=\"12:4000\" end=\"12:49.9930\"/>\n\n</Item>\n",
        workflow_name: "avalon",
        <Span label=\"Track 12. For John Kirkpatrick: WIth bounce\" begin=\"1:50\" end=\"1:59.99\"/>\n    </Div>\n    <Span label=\"Track 13. Copland, Danzon Cubano\" begin=\"2:00\" end=\"2:30\"/>\n</Item>\npercent_complete: "100.0",
        percent_succeeded: "100.0",
        percent_failed: "0",
        status_code: "COMPLETED"
}]

:import_bib_record – boolean. If true, fields must include value for :bibliographic_id and may include value from controlled vocabulary for :bibliographic_id_label)

Bib import failure will result in a JSON response: {errors: ['Bib import failed', e.message]}, status: 422

:replace_masterfiles - boolean. Relevant only if the media object already exists and it has masterfiles. If true, existing masterfiles will be replaced by those sent. If false, sent masterfiles will be appended to existing list.

...