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

import org.red5.server.api.stream.IPlayItem;
import org.red5.server.messaging.IMessageInput;

/**
 * Dynamic playlist item implementation
 */
public class DynamicPlayItem implements IPlayItem {

    /**
     * Playlist item name
     */
    protected final String name;

    /**
     * Start mark
     */
    protected final long start;

    /**
     * Length - amount to play
     */
    protected final long length;

    /**
     * Size - for VOD items this will be the file size
     */
    protected long size = -1;

    /**
     * Offset
     */
    protected double offset;

    /**
     * Message source
     */
    protected IMessageInput msgInput;

    private DynamicPlayItem(String name, long start, long length) {
        this.name = name;
        this.start = start;
        this.length = length;
    }

    private DynamicPlayItem(String name, long start, long length, double offset) {
        this.name = name;
        this.start = start;
        this.length = length;
        this.offset = offset;
    }

    /**
     * Returns play item length in milliseconds
     * 
     * @return Play item length in milliseconds
     */
    public long getLength() {
        return length;
    }

    /**
     * Returns IMessageInput object. IMessageInput is an endpoint for a consumer to connect.
     * 
     * @return IMessageInput object
     */
    public IMessageInput getMessageInput() {
        return msgInput;
    }

    /**
     * Returns item name
     * 
     * @return item name
     */
    public String getName() {
        return name;
    }

    /**
     * Returns boolean value that specifies whether item can be played
     */
    public long getStart() {
        return start;
    }

    /**
     * Alias for getMessageInput
     * 
     * @return Message input source
     */
    public IMessageInput getMsgInput() {
        return msgInput;
    }

    /**
     * Setter for message input
     *
     * @param msgInput
     *            Message input
     */
    public void setMsgInput(IMessageInput msgInput) {
        this.msgInput = msgInput;
    }

    /**
     * Returns size in bytes
     * 
     * @return size
     */
    public long getSize() {
        return size;
    }

    /**
     * Set the size in bytes
     * 
     * @param size
     *            size in bytes
     */
    public void setSize(long size) {
        this.size = size;
    }

    @Override
    public int hashCode() {
        final int prime = 31;
        int result = 1;
        result = prime * result + ((name == null) ? 0 : name.hashCode());
        result = prime * result + (int) (size ^ (size >>> 32));
        result = prime * result + (int) (start ^ (start >>> 32));
        return result;
    }

    @Override
    public boolean equals(Object obj) {
        if (this == obj)
            return true;
        if (obj == null)
            return false;
        if (getClass() != obj.getClass())
            return false;
        DynamicPlayItem other = (DynamicPlayItem) obj;
        if (name == null) {
            if (other.name != null)
                return false;
        } else if (!name.equals(other.name))
            return false;
        if (size != other.size)
            return false;
        if (start != other.start)
            return false;
        return true;
    }

    /**
     * Builder for DynamicPlayItem
     * 
     * @param name
     *            name
     * @param start
     *            start
     * @param length
     *            length
     * @return play item instance
     */
    public static DynamicPlayItem build(String name, long start, long length) {
        DynamicPlayItem playItem = new DynamicPlayItem(name, start, length);
        return playItem;
    }

    /**
     * Builder for DynamicPlayItem
     * 
     * @param name
     *            name
     * @param start
     *            start
     * @param length
     *            length
     * @param offset
     *            offset
     * @return play item instance
     */
    public static DynamicPlayItem build(String name, long start, long length, double offset) {
        DynamicPlayItem playItem = new DynamicPlayItem(name, start, length, offset);
        return playItem;
    }

}