OutputCompleteEvent.java

/**
 * Copyright 2010-2011 Voxeo Corporation
 *
 * 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 com.voxeo.moho.event;

/**
 * This event is fired when an {@link com.voxeo.moho.media.Output Output} is
 * completed.
 * 
 * @author wchen
 */
public interface OutputCompleteEvent<T extends EventSource> extends MediaCompleteEvent<T> {
  public enum Cause {
    /** the output is terminated by bargein */
    BARGEIN,
    /** the output is terminated by exceeding its max time allowed */
    TIMEOUT,
    /** the output is terminated by unknown error */
    ERROR,
    /** the output is canceled */
    CANCEL,
    /** the output is completed */
    END,
    /** the output is terminated because the source is disconnected */
    DISCONNECT,
    /** the output is terminated for unknown reason */
    UNKNOWN
  }

  /**
   * @return the cause of the completion.
   */
  Cause getCause();

  /**
   * get error description text.
   * 
   * @return
   */
  String getErrorText();
}