stream_cmd.hpp

Go to the documentation of this file.

/*
 * Copyright 2010-2012,2015 Ettus Research LLC
 * Copyright 2018 Ettus Research, a National Instruments Company
 *
 * SPDX-License-Identifier: GPL-3.0-or-later
 */
 
#pragma once
 
#include <uhd/config.hpp>
#include <uhd/types/time_spec.hpp>
#include <cstdint>
 
namespace uhd {

struct UHD_API stream_cmd_t
{
    enum stream_mode_t : uint32_t {
        STREAM_MODE_START_CONTINUOUS   = int('a'),
        STREAM_MODE_STOP_CONTINUOUS    = int('o'),
        STREAM_MODE_NUM_SAMPS_AND_DONE = int('d'),
        STREAM_MODE_NUM_SAMPS_AND_MORE = int('m')
    } stream_mode;
    uint64_t num_samps;

    //
    // When false, the device will start streaming based on the \p trigger source.
    bool stream_now;
    time_spec_t time_spec;

    //
    // When \p stream_now is false, the trigger source controls when
    // streaming begins. The default trigger source is TIMED, meaning
    // that streaming will begin when the time specified in time_spec is reached.
    enum class trigger_t {
        TIMED,
        TX_RUNNING,
    } trigger;
 
    stream_cmd_t(const stream_mode_t& stream_mode);
};
 
} /* namespace uhd */