File SpinVideoC.h

File List > include > spinc > SpinVideoC.h

Go to the documentation of this file

//=============================================================================
// Copyright (c) 2026 FLIR Integrated Imaging Solutions, Inc. All Rights Reserved.
//
// This software is the confidential and proprietary information of FLIR
// Integrated Imaging Solutions, Inc. ("Confidential Information"). You
// shall not disclose such Confidential Information and shall use it only in
// accordance with the terms of the license agreement you entered into
// with FLIR Integrated Imaging Solutions, Inc. (FLIR).
//
// FLIR MAKES NO REPRESENTATIONS OR WARRANTIES ABOUT THE SUITABILITY OF THE
// SOFTWARE, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
// PURPOSE, OR NON-INFRINGEMENT. FLIR SHALL NOT BE LIABLE FOR ANY DAMAGES
// SUFFERED BY LICENSEE AS A RESULT OF USING, MODIFYING OR DISTRIBUTING
// THIS SOFTWARE OR ITS DERIVATIVES.
//=============================================================================

#ifndef FLIR_SPIN_VIDEO_C_H
#define FLIR_SPIN_VIDEO_C_H

#include "SpinnakerPlatformC.h"

#include "SpinnakerDefsC.h"

#ifdef _MSC_VER
#pragma warning(push)
#pragma warning(disable : 4996)
#elif defined(__GNUC__)
#pragma GCC diagnostic push
#pragma GCC diagnostic ignored "-Wdeprecated-declarations"
#endif

#ifdef __cplusplus
extern "C"
{
#endif

    /*
     * Opens an empty video file to create an uncompressed video
     * @see spinError
     *
     * @param phSpinVideo The spinVideo handle pointer in which the spin video recorder is returned
     * @param pName The filename to save the video as; do not include the extension
     * @param option The video options related to saving as uncompressed video; includes frame rate
     *
     *
     * @return spinError The error code; returns SPINNAKER_ERR_SUCCESS (or 0) for no error
     */
    SPINNAKERC_API spinVideoOpenUncompressed(spinVideo* phSpinVideo, const char* pName, spinAVIOption option);

    /*
     * Opens an empty video file to create an MJPG file
     * @see spinError
     *
     * @param phSpinVideo The spinVideo handle pointer in which the spin video recorder is returned
     * @param pName The filename to save the video as; do not include the extension
     * @param option The video options related to saving as MJPG; includes frame rate and quality
     *
     * @return spinError The error code; returns SPINNAKER_ERR_SUCCESS (or 0) for no error
     */
    SPINNAKERC_API spinVideoOpenMJPG(spinVideo* phSpinVideo, const char* pName, spinMJPGOption option);

    /*
     * Opens an empty video file to create an H264 MP4 file
     * @see spinError
     *
     * @param phSpinVideo The spinVideo handle pointer in which the spin video recorder is returned
     * @param pName The filename to save the video as; do not include the extension
     * @param option The video options related to saving as MJPG; includes frame rate, bitrate, height, and width
     *
     * @return spinError The error code; returns SPINNAKER_ERR_SUCCESS (or 0) for no error
     */
    SPINNAKERC_API spinVideoOpenH264(spinVideo* phSpinVideo, const char* pName, spinH264Option option);

    /*
     * Appends an image to the end of an open video file
     * @see spinError
     *
     * @param hSpinVideo The spin video recorder to append the image to
     * @param hImage The image to append
     *
     * @return spinError The error code; returns SPINNAKER_ERR_SUCCESS (or 0) for no error
     */
    SPINNAKERC_API spinVideoAppend(spinVideo hSpinVideo, spinImage hImage);

    SPINNAKERC_API spinVideoSetMaximumFileSize(spinVideo hSpinVideo, unsigned int size);

    /*
     * Closes a video file to complete its creation
     * @see spinError
     *
     * @param hSpinVideo The spin video recorder to close
     *
     * @return spinError The error code; returns SPINNAKER_ERR_SUCCESS (or 0) for no error
     */
    SPINNAKERC_API spinVideoClose(spinVideo hSpinVideo);
#ifdef __cplusplus
}
#endif

#ifdef _MSC_VER
#pragma warning(pop)
#elif defined(__GNUC__)
#pragma GCC diagnostic pop
#endif

#endif /* FLIR_SPIN_VIDEO_C_H */