001/* 002 * (C) Copyright 2006-2011 Nuxeo SA (http://nuxeo.com/) and others. 003 * 004 * All rights reserved. This program and the accompanying materials 005 * are made available under the terms of the GNU Lesser General Public License 006 * (LGPL) version 2.1 which accompanies this distribution, and is available at 007 * http://www.gnu.org/licenses/lgpl-2.1.html 008 * 009 * This library is distributed in the hope that it will be useful, 010 * but WITHOUT ANY WARRANTY; without even the implied warranty of 011 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 012 * Lesser General Public License for more details. 013 * 014 * Contributors: 015 * Thomas Roger <troger@nuxeo.com> 016 */ 017 018package org.nuxeo.ecm.platform.video; 019 020import java.util.Collection; 021 022/** 023 * Interface for document adapter wrapping a Video document. 024 * <p> 025 * Gives access to the videos and related info stored in the underlying document. 026 * 027 * @author <a href="mailto:troger@nuxeo.com">Thomas Roger</a> 028 * @since 5.5 029 */ 030public interface VideoDocument { 031 032 /** 033 * Returns the main {@link Video} of this {@code VideoDocument}. 034 */ 035 Video getVideo(); 036 037 /** 038 * Returns all the {@link TranscodedVideo}s for this {@code VideoDocument}. 039 */ 040 Collection<TranscodedVideo> getTranscodedVideos(); 041 042 /** 043 * Returns a given {@link TranscodedVideo} based on its {@code name}, {@code null} if this transcoded video does not 044 * exist. 045 */ 046 TranscodedVideo getTranscodedVideo(String name); 047}