sdk/fidl/fuchsia.audio.mixer/create_graph_options.fidl

// Copyright 2022 The Fuchsia Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

library fuchsia.audio.mixer;

using zx;

/// Options for [`GraphCreator.CreateGraph`].
type CreateGraphOptions = resource table {
    /// Name of this graph, used for diagnostics only.
    /// If specified, ideally this should be globally unique and have a
    /// printable CamelCase format, but this is not validated.
    ///
    /// Optional. Empty if not specified.
    1: name string:MAX_NAME_LENGTH;

    /// Each graph has two threads dedicated to handling FIDL requests: a main
    /// thread, which handles time-insensitive requests, and a real-time FIDL
    /// thread, which handles time-sensitive requests. This field provides a
    /// deadline profile for the real-time FIDL thread.
    ///
    /// For example, all `[fuchsia.media2/StreamSink`] servers run on the
    /// real-time FIDL thread. Packets sent on this protocol must be read
    /// immediately, otherwise the caller may miss their deadline.
    ///
    /// Optional. If not specified, the real-time FIDL thread runs at a normal
    /// priority.
    2: realtime_fidl_thread_deadline_profile zx.handle:PROFILE;
};