001/*******************************************************************************
002 * Copyright (c) 2024, 2026, Olivier Ayache.  All rights reserved.
003 *
004 * This file is part of AVPKit.
005 *
006 * AVPKit is free software: you can redistribute it and/or modify
007 * it under the terms of the GNU Lesser General Public License as published by
008 * the Free Software Foundation, either version 3 of the License, or
009 * (at your option) any later version.
010 *
011 * AVPKit is distributed in the hope that it will be useful,
012 * but WITHOUT ANY WARRANTY; without even the implied warranty of
013 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
014 * GNU Lesser General Public License for more details.
015 *
016 * You should have received a copy of the GNU Lesser General Public License
017 * along with AVPKit.  If not, see <http://www.gnu.org/licenses/>.
018 *******************************************************************************/
019
020package com.avpkit.mediatool.event;
021
022/**
023 * An {@link IEvent} that corresponds to a stream
024 * in some container.
025 * 
026 * @author aclarke
027 *
028 */
029public interface IStreamEvent extends IEvent
030{
031
032  /**
033   * Get the stream index.
034   * 
035   * The stream index can be null if the 
036   * {@link com.avpkit.mediatool.IMediaGenerator} that
037   * generated this event has no concept of streams.
038   * 
039   * @return the stream index if known, or null if not
040   */
041  public abstract Integer getStreamIndex();
042
043}