/*
 * 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.gagravarr.ogg.audio;

import org.gagravarr.ogg.OggStreamPacket;

/**
 * Common interface for the Info (Information /
 *  Identification) header at the start of an
 *  {@link OggAudioStream}
 */
public interface OggAudioInfoHeader extends OggStreamPacket {
    /**
     * @return The version of the codec / format used
     */
    public String getVersionString();

    // TODO Can we bring any more common things across?

    /**
     * @return The number of channels (1=mono, 2=stereo etc)
     */
    public int getNumChannels();
    /**
     * @return Sample rate in Hz
     */
    public int getSampleRate();
    /**
     * @return The number of samples to be skipped from the beginning of the stream
     */
    public int getPreSkip();
}
