org.red5.server.api.stream.IStreamCapableConnection Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ant-media-server-common Show documentation
Classes common for multiple Ant Media projects
There is a newer version: 2.3.3.1
Show newest version
/*
 * 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.server.api.stream;

import java.util.Map;

import org.red5.server.api.IConnection;

/**
 * A connection that supports streaming.
 * 
 * @author The Red5 Project
 * @author Luke Hubbard ([email protected])
 * @author Steven Gong ([email protected])
 */
public interface IStreamCapableConnection extends IConnection {

    /**
     * Return a reserved stream id for use. According to FCS/FMS regulation, the base is 1.
     * 
     * @return Reserved stream id
     * @throws IndexOutOfBoundsException
     *             when it is impossible to reserve new stream
     */
    Number reserveStreamId() throws IndexOutOfBoundsException;

    /**
     * Return a reserved stream id for use with a preference for the one supplied.
     * 
     * @param streamId
     *            supplied stream id
     * @return Reserved stream id
     * @throws IndexOutOfBoundsException
     *             when it is impossible to reserve new stream
     */
    Number reserveStreamId(Number streamId) throws IndexOutOfBoundsException;

    /**
     * Unreserve this id for future use.
     * 
     * @param streamId
     *            ID of stream to unreserve
     */
    void unreserveStreamId(Number streamId);

    /**
     * Deletes the stream with the given id.
     * 
     * @param streamId
     *            ID of stream to delete
     */
    void deleteStreamById(Number streamId);

    /**
     * Get a stream by its id.
     * 
     * @param streamId
     *            Stream id
     * @return Stream with given id
     */
    IClientStream getStreamById(Number streamId);

    /**
     * Create a stream that can play only one item.
     * 
     * @param streamId
     *            Stream id
     * @return New subscriber stream that can play only one item
     */
    ISingleItemSubscriberStream newSingleItemSubscriberStream(Number streamId);

    /**
     * Create a stream that can play a list.
     * 
     * @param streamId
     *            Stream id
     * @return New stream that can play sequence of items
     */
    IPlaylistSubscriberStream newPlaylistSubscriberStream(Number streamId);

    /**
     * Create a broadcast stream.
     * 
     * @param streamId
     *            Stream id
     * @return New broadcast stream
     */
    IClientBroadcastStream newBroadcastStream(Number streamId);

    /**
     * Total number of video messages that are pending to be sent to a stream.
     *
     * @param streamId
     *            Stream id
     * @return Number of pending video messages
     */
    long getPendingVideoMessages(Number streamId);

    Map getStreamsMap();

}