org.red5.io.flv.IFLV Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ant-media-server Show documentation
Ant Media Server supports RTMP, RTSP, MP4, HLS, WebRTC, Adaptive Streaming, etc.
There is a newer version: 2.11.3
/*
 * RED5 Open Source Media Server - https://github.com/Red5/ Copyright 2006-2016 by respective authors (see below). All rights reserved. Licensed under the Apache License, Version
 * 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless
 * required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
 * either express or implied. See the License for the specific language governing permissions and limitations under the License.
 */

package org.red5.io.flv;

import java.io.FileNotFoundException;
import java.io.IOException;
import java.util.Map;

import org.red5.cache.ICacheStore;
import org.red5.io.IStreamableFile;
import org.red5.io.ITagReader;
import org.red5.io.ITagWriter;
import org.red5.io.flv.meta.IMetaData;
import org.red5.io.flv.meta.IMetaService;

/**
 * Represents FLV file
 */
public interface IFLV extends IStreamableFile {

    /**
     * Returns a boolean stating whether the flv has metadata
     * 
     * @return boolean true if file has injected metadata, false otherwise
     */
    public boolean hasMetaData();

    /**
     * Sets the metadata
     * 
     * @param metadata
     *            Metadata object
     * @throws FileNotFoundException
     *             File not found
     * @throws IOException
     *             Any other I/O exception
     */
    @SuppressWarnings({ "rawtypes" })
    public void setMetaData(IMetaData metadata) throws FileNotFoundException, IOException;

    /**
     * Sets the MetaService through Spring
     * 
     * @param service
     *            Metadata service
     */
    public void setMetaService(IMetaService service);

    /**
     * Returns a map of the metadata
     * 
     * @return metadata File metadata
     * @throws FileNotFoundException
     *             File not found
     */
    @SuppressWarnings({ "rawtypes" })
    public IMetaData getMetaData() throws FileNotFoundException;

    /**
     * Returns a boolean stating whether a flv has keyframedata
     * 
     * @return boolean true if file has keyframe metadata, false otherwise
     */
    public boolean hasKeyFrameData();

    /**
     * Sets the keyframe data of a flv file
     * 
     * @param keyframedata
     *            Keyframe metadata
     */
    @SuppressWarnings({ "rawtypes" })
    public void setKeyFrameData(Map keyframedata);

    /**
     * Gets the keyframe data
     * 
     * @return keyframedata Keyframe metadata
     */
    @SuppressWarnings({ "rawtypes" })
    public Map getKeyFrameData();

    /**
     * Refreshes the headers. Usually used after data is added to the flv file
     * 
     * @throws IOException
     *             Any I/O exception
     */
    public void refreshHeaders() throws IOException;

    /**
     * Flushes Header
     * 
     * @throws IOException
     *             Any I/O exception
     */
    public void flushHeaders() throws IOException;

    /**
     * Returns a Reader closest to the nearest keyframe
     * 
     * @param seekPoint
     *            Point in file we are seeking around
     * @return reader Tag reader closest to that point
     */
    public ITagReader readerFromNearestKeyFrame(int seekPoint);

    /**
     * Returns a Writer based on the nearest key frame
     * 
     * @param seekPoint
     *            Point in file we are seeking around
     * @return writer Tag writer closest to that point
     */
    public ITagWriter writerFromNearestKeyFrame(int seekPoint);

    /**
     * Sets the caching implemenation
     * 
     * @param cache
     *            cache
     */
    public void setCache(ICacheStore cache);
}