org.red5.server.api.stream.IClientStream 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;

/**
 * A stream that is bound to a client.
 * 
 * @author The Red5 Project
 * @author Steven Gong ([email protected])
 */
public interface IClientStream extends IStream {

    public static final String MODE_READ = "read";

    public static final String MODE_RECORD = "record";

    public static final String MODE_APPEND = "append";

    public static final String MODE_LIVE = "live";

    public static final String MODE_PUBLISH = "publish";

    /**
     * Get stream id allocated in a connection.
     * 
     * @return the stream id
     */
    Number getStreamId();

    /**
     * Get connection containing the stream.
     * 
     * @return the connection object or null if the connection is no longer active
     */
    IStreamCapableConnection getConnection();

    /**
     * Set the buffer duration for this stream as requested by the client.
     * 
     * @param bufferTime duration in ms the client wants to buffer
     */
    void setClientBufferDuration(int bufferTime);

    /**
     * Get the buffer duration for this stream as requested by the client.
     * 
     * @return bufferTime duration in ms the client wants to buffer
     */
    int getClientBufferDuration();

    /**
     * Set the published stream name that this client is consuming.
     *
     * @param streamName of stream being consumed
     */
    void setBroadcastStreamPublishName(String streamName);

    /**
     * Returns the published stream name that this client is consuming.
     * 
     * @return stream name of stream being consumed
     */
    String getBroadcastStreamPublishName();

}