001/*
002 * (C) Copyright 2006-2011 Nuxeo SA (http://nuxeo.com/) and others.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *     http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 *
016 * Contributors:
017 *     Thomas Roger <troger@nuxeo.com>
018 */
019
020package org.nuxeo.ecm.platform.video;
021
022import java.util.Collection;
023
024/**
025 * Interface for document adapter wrapping a Video document.
026 * <p>
027 * Gives access to the videos and related info stored in the underlying document.
028 *
029 * @author <a href="mailto:troger@nuxeo.com">Thomas Roger</a>
030 * @since 5.5
031 */
032public interface VideoDocument {
033
034    /**
035     * Returns the main {@link Video} of this {@code VideoDocument}.
036     */
037    Video getVideo();
038
039    /**
040     * Returns all the {@link TranscodedVideo}s for this {@code VideoDocument}.
041     */
042    Collection<TranscodedVideo> getTranscodedVideos();
043
044    /**
045     * Returns a given {@link TranscodedVideo} based on its {@code name}, {@code null} if this transcoded video does not
046     * exist.
047     */
048    TranscodedVideo getTranscodedVideo(String name);
049}