\hypertarget{transport_8h}{ \section{transport.h File Reference} \label{transport_8h}\index{transport.h@{transport.h}} } {\tt \#include $<$jack/types.h$>$}\par \subsection*{Data Structures} \begin{CompactItemize} \item struct \hyperlink{structjack__transport__info__t}{jack\_\-transport\_\-info\_\-t} \end{CompactItemize} \subsection*{Defines} \begin{CompactItemize} \item \#define \hyperlink{transport_8h_a0}{EXTENDED\_\-TIME\_\-INFO} \end{CompactItemize} \subsection*{Enumerations} \begin{CompactItemize} \item enum \hyperlink{transport_8h_a11}{jack\_\-transport\_\-state\_\-t} \{ \hyperlink{transport_8h_a11a1}{Jack\-Transport\-Stopped}, \hyperlink{transport_8h_a11a2}{Jack\-Transport\-Rolling}, \hyperlink{transport_8h_a11a3}{Jack\-Transport\-Looping} \} \item enum \hyperlink{transport_8h_a12}{jack\_\-transport\_\-bits\_\-t} \{ \par \hyperlink{transport_8h_a12a4}{Jack\-Transport\-State} = 0x1, \hyperlink{transport_8h_a12a5}{Jack\-Transport\-Position} = 0x2, \hyperlink{transport_8h_a12a6}{Jack\-Transport\-Loop} = 0x4, \hyperlink{transport_8h_a12a7}{Jack\-Transport\-SMPTE} = 0x8, \par \hyperlink{transport_8h_a12a8}{Jack\-Transport\-BBT} = 0x10 \} \end{CompactItemize} \subsection*{Functions} \begin{CompactItemize} \item void \hyperlink{transport_8h_a9}{jack\_\-set\_\-transport\_\-info} (\hyperlink{types_8h_a6}{jack\_\-client\_\-t} $\ast$client, \hyperlink{structjack__transport__info__t}{jack\_\-transport\_\-info\_\-t} $\ast$tinfo) \item void \hyperlink{transport_8h_a10}{jack\_\-get\_\-transport\_\-info} (\hyperlink{types_8h_a6}{jack\_\-client\_\-t} $\ast$client, \hyperlink{structjack__transport__info__t}{jack\_\-transport\_\-info\_\-t} $\ast$tinfo) \end{CompactItemize} \subsection{Define Documentation} \hypertarget{transport_8h_a0}{ \index{transport.h@{transport.h}!EXTENDED_TIME_INFO@{EXTENDED\_\-TIME\_\-INFO}} \index{EXTENDED_TIME_INFO@{EXTENDED\_\-TIME\_\-INFO}!transport.h@{transport.h}} \subsubsection[EXTENDED\_\-TIME\_\-INFO]{\setlength{\rightskip}{0pt plus 5cm}\#define EXTENDED\_\-TIME\_\-INFO}} \label{transport_8h_a0} \subsection{Enumeration Type Documentation} \hypertarget{transport_8h_a12}{ \index{transport.h@{transport.h}!jack_transport_bits_t@{jack\_\-transport\_\-bits\_\-t}} \index{jack_transport_bits_t@{jack\_\-transport\_\-bits\_\-t}!transport.h@{transport.h}} \subsubsection[jack\_\-transport\_\-bits\_\-t]{\setlength{\rightskip}{0pt plus 5cm}enum \hyperlink{transport_8h_a12}{jack\_\-transport\_\-bits\_\-t}}} \label{transport_8h_a12} Bitfield of all possible transport info struct fields. \begin{Desc} \item[See also:]\hyperlink{structjack__transport__info__t}{jack\_\-transport\_\-info\_\-t} \end{Desc} \begin{Desc} \item[Enumeration values: ]\par \begin{description} \index{JackTransportState@{JackTransportState}!transport.h@{transport.h}}\index{transport.h@{transport.h}!JackTransportState@{JackTransportState}}\item[{\em \hypertarget{transport_8h_a12a4}{ {\em Jack\-Transport\-State}} \label{transport_8h_a12a4} }]\index{JackTransportPosition@{JackTransportPosition}!transport.h@{transport.h}}\index{transport.h@{transport.h}!JackTransportPosition@{JackTransportPosition}}\item[{\em \hypertarget{transport_8h_a12a5}{ {\em Jack\-Transport\-Position}} \label{transport_8h_a12a5} }]\index{JackTransportLoop@{JackTransportLoop}!transport.h@{transport.h}}\index{transport.h@{transport.h}!JackTransportLoop@{JackTransportLoop}}\item[{\em \hypertarget{transport_8h_a12a6}{ {\em Jack\-Transport\-Loop}} \label{transport_8h_a12a6} }]\index{JackTransportSMPTE@{JackTransportSMPTE}!transport.h@{transport.h}}\index{transport.h@{transport.h}!JackTransportSMPTE@{JackTransportSMPTE}}\item[{\em \hypertarget{transport_8h_a12a7}{ {\em Jack\-Transport\-SMPTE}} \label{transport_8h_a12a7} }]\index{JackTransportBBT@{JackTransportBBT}!transport.h@{transport.h}}\index{transport.h@{transport.h}!JackTransportBBT@{JackTransportBBT}}\item[{\em \hypertarget{transport_8h_a12a8}{ {\em Jack\-Transport\-BBT}} \label{transport_8h_a12a8} }]\end{description} \end{Desc} \hypertarget{transport_8h_a11}{ \index{transport.h@{transport.h}!jack_transport_state_t@{jack\_\-transport\_\-state\_\-t}} \index{jack_transport_state_t@{jack\_\-transport\_\-state\_\-t}!transport.h@{transport.h}} \subsubsection[jack\_\-transport\_\-state\_\-t]{\setlength{\rightskip}{0pt plus 5cm}enum \hyperlink{transport_8h_a11}{jack\_\-transport\_\-state\_\-t}}} \label{transport_8h_a11} Possible transport states. \begin{Desc} \item[Enumeration values: ]\par \begin{description} \index{JackTransportStopped@{JackTransportStopped}!transport.h@{transport.h}}\index{transport.h@{transport.h}!JackTransportStopped@{JackTransportStopped}}\item[{\em \hypertarget{transport_8h_a11a1}{ {\em Jack\-Transport\-Stopped}} \label{transport_8h_a11a1} }]\index{JackTransportRolling@{JackTransportRolling}!transport.h@{transport.h}}\index{transport.h@{transport.h}!JackTransportRolling@{JackTransportRolling}}\item[{\em \hypertarget{transport_8h_a11a2}{ {\em Jack\-Transport\-Rolling}} \label{transport_8h_a11a2} }]\index{JackTransportLooping@{JackTransportLooping}!transport.h@{transport.h}}\index{transport.h@{transport.h}!JackTransportLooping@{JackTransportLooping}}\item[{\em \hypertarget{transport_8h_a11a3}{ {\em Jack\-Transport\-Looping}} \label{transport_8h_a11a3} }]\end{description} \end{Desc} \subsection{Function Documentation} \hypertarget{transport_8h_a10}{ \index{transport.h@{transport.h}!jack_get_transport_info@{jack\_\-get\_\-transport\_\-info}} \index{jack_get_transport_info@{jack\_\-get\_\-transport\_\-info}!transport.h@{transport.h}} \subsubsection[jack\_\-get\_\-transport\_\-info]{\setlength{\rightskip}{0pt plus 5cm}void jack\_\-get\_\-transport\_\-info (\hyperlink{types_8h_a6}{jack\_\-client\_\-t} $\ast$ {\em client}, \hyperlink{structjack__transport__info__t}{jack\_\-transport\_\-info\_\-t} $\ast$ {\em tinfo})}} \label{transport_8h_a10} Gets the current transport state. On return, the 'valid' field of the tinfo struct will contain a bitmask of all transport info fields that are legal to use. \begin{Desc} \item[Precondition:]Must be called from the process() thread. \end{Desc} \hypertarget{transport_8h_a9}{ \index{transport.h@{transport.h}!jack_set_transport_info@{jack\_\-set\_\-transport\_\-info}} \index{jack_set_transport_info@{jack\_\-set\_\-transport\_\-info}!transport.h@{transport.h}} \subsubsection[jack\_\-set\_\-transport\_\-info]{\setlength{\rightskip}{0pt plus 5cm}void jack\_\-set\_\-transport\_\-info (\hyperlink{types_8h_a6}{jack\_\-client\_\-t} $\ast$ {\em client}, \hyperlink{structjack__transport__info__t}{jack\_\-transport\_\-info\_\-t} $\ast$ {\em tinfo})}} \label{transport_8h_a9} Sets the transport state for the next engine cycle. The 'valid' field of the tinfo struct should contain a bitmask of all transport info fields that are set in tinfo. \begin{Desc} \item[Precondition:]Caller must be the current timebase master. Must be called from the process() thread. \end{Desc}