pocketstation 1.0.1

Source-aware desktop audio Session SDK
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142

mod compile;
pub(crate) mod declaration;
pub(crate) mod error;
pub(crate) mod error_code;
pub(crate) mod extensions;
pub(crate) mod lifecycle;
mod prepare;

pub use crate::endpoint::{
    PolledAudioBatchLease, PolledAudioEndpoint, PolledAudioEndpointConfig,
    PolledAudioEndpointConfigError, PolledAudioFrame, PolledAudioObservations,
    PolledAudioPollError, PolledAudioReceipt,
};
pub use compile::{CompiledSession, SessionCompileError, SessionCompiler};
pub use declaration::{ApplicationSelector, DeviceSelector, Source};
pub use declaration::{
    ConnectionSpec, ConnectionTarget, EndpointSpec, OperatorInstanceId, SessionSpec,
    SourceInstanceId, SourceOutputSpec, StreamOrigin,
};
#[cfg(any(test, feature = "internal-testing"))]
pub use declaration::{
    DerivedStreamHandle, OperatorInputHandle, OperatorInstanceHandle, SourceInstanceHandle,
};
#[cfg(any(test, feature = "internal-testing"))]
pub use declaration::{DeviceId, ProcessId};
pub use declaration::{
    EndpointConfiguration, EndpointDescriptor, OperatorId, BROWSER_NODE_TYPE_ID,
    BROWSER_OPERATOR_ID, CONNECTOR_NODE_TYPE_ID,
};
pub use declaration::{EndpointHandle, Operator, Session, SourceOutputHandle, StemHandle};
#[cfg(any(test, feature = "internal-testing"))]
pub use declaration::{OperatorInstanceSpec, StemSpec};
#[cfg(any(test, feature = "internal-testing"))]
#[allow(deprecated)]
pub use declaration::{OperatorSpec, SessionSpecVersion, SESSION_SPEC_VERSION};
#[cfg(any(test, feature = "internal-testing"))]
pub use declaration::{Stream, StreamSignal, TypedOperator, TypedStreamError};
pub use error::SessionError;
#[cfg(any(test, feature = "internal-testing"))]
pub use error_code::{
    polled_audio_poll_error_code, session_declaration_error_code, session_start_failure_code,
    PolledAudioPollErrorCode, SessionDeclarationErrorCode, SessionStartErrorCode,
};
pub use error_code::{
    session_stop_failure_codes, SessionRuntimeErrorCode, SessionStopCode, SessionStopFailureCode,
};
#[cfg(any(test, feature = "internal-testing"))]
pub use extensions::register_session_structural_nodes;
pub use extensions::SessionStructuralNodeRegistrationError;
pub use extensions::{
    session_recording_outcome_error_code, SessionRecordingErrorCode, SessionRecordingObservations,
    SessionRecordingState, SessionRecordingStemOutcome,
};
pub use extensions::{
    PreparedSourceRuntime, SourceConfiguration, SourceOutputBranchSpec, SourceOutputIdentity,
    SourceRegistry, SourceRuntime, SourceRuntimeObservationHandle, SourceRuntimeObservations,
    SourceSessionContext, SourceTypeId,
};
pub use extensions::{SessionRecordingOutcome, SessionRecordingReceipt};
#[cfg(any(test, feature = "internal-testing"))]
pub use extensions::{
    SourceCancellation, SourceDriver, SourceDriverError, SourceEmission, SourceFactory,
    SourceManifest, SourceManifestError, SourceOutputReceiver, SourcePrepareContext,
    SourceRegistrationError, SourceRuntimeError,
};
#[cfg(any(test, feature = "internal-testing"))]
pub use extensions::{APPLICATION_SOURCE_NODE_TYPE_ID, MICROPHONE_SOURCE_NODE_TYPE_ID};
#[cfg(any(test, feature = "internal-testing"))]
pub use extensions::{
    DEFAULT_MULTISTEM_RECORDING_GROUP_ID, RECORDER_NODE_TYPE_ID, RECORDER_OPERATOR_ID,
    RECORDING_GROUP_CONFIGURATION_KEY,
};
pub use lifecycle::SessionTraceRecorderHandle;
#[cfg(any(test, feature = "internal-testing"))]
pub use lifecycle::{start_prepared_session, start_prepared_session_cancellable};
pub use lifecycle::{
    CaptureBackendSet, RunningSession, SessionStartCancellation, SessionStartError,
    SessionStartFailure, SessionStartOptions, SessionStopOutcome,
};
pub use lifecycle::{
    EndpointExtensionRegistrationError, SessionEngine, SessionEngineBuildError,
    SessionEngineBuilder, SessionEngineStartError,
};
pub use lifecycle::{
    EndpointObservationStage, SessionAudioReentryMetrics, SessionDerivedRouteMetrics,
    SessionExternalSourceMetrics, SessionMetricsSnapshot, SessionOperatorInputMetrics,
    SessionOperatorMetrics, SessionRouteMetrics, SessionSidecarMetrics, SessionSourceMetrics,
};
pub use lifecycle::{
    NativeSessionEngineHostOptions, SessionEngineHost, SessionEngineHostBuildError,
    SessionEngineHostBuilder,
};
pub use lifecycle::{
    SessionComponentId, SessionControlFailure, SessionEndpointFailure, SessionEvent,
    SessionEventKind, SessionEventReceive, SessionEventReceiver, SessionFinalizationFailure,
    SessionFinalizationStage, SessionLifecycleState, SessionRollbackFailure, SessionRollbackStage,
    SessionSourceFailure, SessionTerminalOutcome, SessionTerminalState,
};
#[cfg(any(test, feature = "internal-testing"))]
pub use lifecycle::{
    SessionEventQueueObservations, SessionRouteDropObservations, SessionRouteLatencyBoundary,
    SessionRouteLatencyObservations, SessionRouteLatencyUnit, SessionRouteObservationInterval,
};
#[cfg(any(test, feature = "internal-testing"))]
pub use lifecycle::{
    SessionTrace, SessionTraceRecorder, SessionTraceRecorderFinishError,
    SessionTraceRecorderOutcome, SessionTraceRecorderStartError, SessionTraceValidation,
    SessionTraceValidationError,
};
#[cfg(any(test, feature = "internal-testing"))]
pub use lifecycle::{SessionTraceRecord, SessionTraceRecordKind, SessionTraceTerminal};
#[cfg(any(test, feature = "internal-testing"))]
pub use prepare::PreparedSourceMapping;
#[cfg(any(test, feature = "internal-testing"))]
pub use prepare::PreparedWorkerMapping;
pub use prepare::{prepare_session_runtime, PreparedSession, SessionPrepareError};

#[cfg(any(test, feature = "internal-testing"))]
pub use crate::frame::ConnectorId;
#[cfg(any(test, feature = "internal-testing"))]
pub use crate::frame::{
    AudioBufferPool, AudioFrame, AudioFrameBuildError, ClockDomainId, FrameLineage,
    FrameLineageBuildError, SourceId, StreamId,
};
pub use crate::frame::{EndpointId, RouteId, SampleFormat, SampleSpec, SessionId, StemId};
#[cfg(any(test, feature = "internal-testing"))]
pub use crate::graph::NodeRegistrationError;
#[cfg(any(test, feature = "internal-testing"))]
pub use crate::graph::{
    AsyncNode, AsyncNodeFuture, AsyncOperatorFactory, AsyncOperatorManifest,
    AsyncOperatorManifestError, AudioCaps, BackpressurePolicy, BinaryFormat, ChannelLayout,
    ClockDomain, Codec, ConfigError, CopyPolicy, DeliverySemantics, EdgeContract,
    EdgeObservabilityLevel, EventFormat, ExecutionPartition, LossPolicy, MediaCaps, MediaKind,
    Multiplicity, NodeDefinition, NodeDescriptor, NodeError, OperatorCancellationPolicy,
    OperatorDeadlinePolicy, OperatorFailurePolicy, OperatorOutputRolePolicy,
    OperatorPermissionPolicy, PortDirection, PortPrepareContext, PortSpec, PrepareContext,
    SafetyContract, SchemaRef, SemanticRole, SignalClass, SignalContinuityError,
    SignalContinuityObservation, SignalContinuityTracker, SignalDerivation, SignalDerivationError,
    SignalEnvelope, SignalEnvelopeError, SignalId, SignalLineage, SignalPayload, SignalSpec,
    SignalSpecError, SignalTiming, TextFormat,
};
pub use crate::graph::{NodeConfig as OperatorConfiguration, NodeTypeId};