audio_playback.hpp

// DO NOT EDIT! This file was auto-generated by crates/build/re_types_builder/src/codegen/cpp/mod.rs
// Based on "crates/build/re_type_definitions/rerun/blueprint/archetypes/audio_playback.def.rs".
 
#pragma once
 
#include "../../blueprint/components/volume.hpp"
#include "../../collection.hpp"
#include "../../component_batch.hpp"
#include "../../component_column.hpp"
#include "../../result.hpp"
 
#include <cstdint>
#include <optional>
#include <utility>
#include <vector>
 
namespace rerun::blueprint::archetypes {
    /// **Archetype**: Playback settings for an audio view.
    ///
    /// ⚠ **This type is _unstable_ and may change significantly in a way that the data won't be backwards compatible.**
    ///
    struct AudioPlayback {
        /// Playback volume, from 0.0 (silent) to 1.0 (full).
        ///
        /// Defaults to 1.0.
        std::optional<ComponentBatch> volume;
 
      public:
        /// The name of the archetype as used in `ComponentDescriptor`s.
        static constexpr const char ArchetypeName[] = "rerun.blueprint.archetypes.AudioPlayback";
 
        /// `ComponentDescriptor` for the `volume` field.
        static constexpr auto Descriptor_volume = ComponentDescriptor(
            ArchetypeName, "AudioPlayback:volume",
            Loggable<rerun::blueprint::components::Volume>::ComponentType
        );
 
      public:
        AudioPlayback() = default;
        AudioPlayback(AudioPlayback&& other) = default;
        AudioPlayback(const AudioPlayback& other) = default;
        AudioPlayback& operator=(const AudioPlayback& other) = default;
        AudioPlayback& operator=(AudioPlayback&& other) = default;
 
        /// Update only some specific fields of a `AudioPlayback`.
        static AudioPlayback update_fields() {
            return AudioPlayback();
        }
 
        /// Clear all the fields of a `AudioPlayback`.
        static AudioPlayback clear_fields();
 
        /// Playback volume, from 0.0 (silent) to 1.0 (full).
        ///
        /// Defaults to 1.0.
        AudioPlayback with_volume(const rerun::blueprint::components::Volume& _volume) && {
            volume = ComponentBatch::from_loggable(_volume, Descriptor_volume).value_or_throw();
            return std::move(*this);
        }
 
        /// Partitions the component data into multiple sub-batches.
        ///
        /// Specifically, this transforms the existing `ComponentBatch` data into `ComponentColumn`s
        /// instead, via `ComponentBatch::partitioned`.
        ///
        /// This makes it possible to use `RecordingStream::send_columns` to send columnar data directly into Rerun.
        ///
        /// The specified `lengths` must sum to the total length of the component batch.
        Collection<ComponentColumn> columns(const Collection<uint32_t>& lengths_);
 
        /// Partitions the component data into unit-length sub-batches.
        ///
        /// This is semantically similar to calling `columns` with `std::vector<uint32_t>(n, 1)`,
        /// where `n` is automatically guessed.
        Collection<ComponentColumn> columns();
    };
 
} // namespace rerun::blueprint::archetypes
 
namespace rerun {
    /// \private
    template <typename T>
    struct AsComponents;
 
    /// \private
    template <>
    struct AsComponents<blueprint::archetypes::AudioPlayback> {
        /// Serialize all set component batches.
        static Result<Collection<ComponentBatch>> as_batches(
            const blueprint::archetypes::AudioPlayback& archetype
        );
    };
} // namespace rerun