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
022import com.avpkit.mediatool.IMediaCoder;
023import com.avpkit.core.IPacket;
024
025/**
026 * An {@link ICoderEvent} and {@link IStreamEvent} that contains
027 * an {@link IPacket} object.
028 * 
029 * @author aclarke
030 *
031 */
032public interface IPacketEvent extends IStreamEvent, ICoderEvent
033{
034
035  /**
036   * Returns the {@link IPacket} for this event.
037   * 
038   * <p>
039   * The returned {@link IPacket} will only be valid for
040   * the duration of the {@link com.avpkit.mediatool.IMediaListener} method call
041   * it was dispatched on and 
042   * implementations must not access it after
043   * that call returns.  If you need to keep a copy of this data
044   * either copy the data into your own object, or
045   * use {@link IPacket#copyReference()} to create a reference
046   * that will outlive your call.
047   * </p>
048   * 
049   * @return the packet
050   */
051  public abstract IPacket getPacket();
052
053  /**
054   * {@inheritDoc}
055   */
056  public abstract IMediaCoder getSource();
057
058}