/* Network-Integrated Multimedia Middleware (NMM)
 * http://www.motama.com/nmm.html
 *
 * Copyright (C) 2006-2007
 * Motama GmbH, Saarbruecken, Germany
 * http://www.motama.com
 *
 * This file is part of NMM. 
 * 
 * NMM is free software; you can redistribute it and/or modify it    
 * under the terms of the GNU General Public License as published by 
 * the Free Software Foundation; only version 2 of the License.      
 * 
 * NMM is distributed in the hope that it will be useful, but WITHOUT 
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY 
 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public 
 * License for more details.  
 * 
 * You should have received a copy of the GNU General Public License 
 * along with NMM; if not, write to the Free Software Foundation,    
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 */

module NMM {
/** Interface specifying modes for creating files.
   */
  interface IFileModeHandler {
    enum FileMode     { FILE_PER_FRAME = 0, FILE_PER_STREAM };
    enum FileFormat   { DATA_ONLY      = 0, SIZE_DATA      , SIZE_TIMESTAMP_DATA };
    enum FilenameMode { FILENAME_ONLY  = 0, FILENAME_BUFCOUNT, TIMESTAMP_AS_NAME };
    
    /** Sets file mode to use.
     *
     * @param mode File mode to be used.
     */
    void setMode(in IFileModeHandler::FileMode mode);

    /** Returns current file mode.
     *
     * @return Current chosen file mode.
     */
    IFileModeHandler::FileMode getMode();

    /** Sets format to be written.
     *
     * @return Current chosen format.
     */
    void setFormat(in IFileModeHandler::FileFormat format);
    
    /** Returns current chosen format.
     *
     * @return Current chosen format.
     */
    IFileModeHandler::FileFormat getFormat();
 
    /** Sets filename mode to use.
     *
     * @param mode Filename mode to be used.
     */
    void setFilenameMode(in IFileModeHandler::FilenameMode mode);
    
    /** Returns current chosen filename mode.
     *
     * @return Current chosen filename mode.
     */
    IFileModeHandler::FilenameMode getFilenameMode();

    /** Switches loop on or off.
     *
     * @param d True if loop is switched on, else otherwise.
     */
    void setLoop(in nmm_bool d);
  };
}
