asset_audio.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/archetypes/asset_audio.def.rs".
 
#pragma once
 
#include "../collection.hpp"
#include "../component_batch.hpp"
#include "../component_column.hpp"
#include "../components/blob.hpp"
#include "../components/media_type.hpp"
#include "../result.hpp"
 
#include <cstdint>
#include <filesystem>
#include <optional>
#include <utility>
#include <vector>
 
namespace rerun::archetypes {
    /// **Archetype**: An audio file, stored as-is (`.aac`, `.flac`, `.m4a`, `.mp3`, `.ogg`, `.wav`).
    ///
    /// The audio starts playing at the time it was logged,
    /// so log it on a temporal timeline (duration or timestamp) at the point where playback should begin.
    /// The viewer plays it while time is playing, in an `views::AudioView`.
    ///
    /// ## Example
    ///
    /// ### Simple audio asset
    /// ```cpp
    /// #include <rerun.hpp>
    ///
    /// #include <iostream>
    ///
    /// int main(int argc, char* argv[]) {
    ///     if (argc <2) {
    ///         std::cerr <<"Usage: " <<argv[0]
    ///                   <<" <path_to_audio.[aac|flac|m4a|mp3|ogg|wav]>" <<std::endl;
    ///         return 1;
    ///     }
    ///
    ///     const auto path = argv[1];
    ///
    ///     const auto rec = rerun::RecordingStream("rerun_example_asset_audio");
    ///     rec.spawn().exit_on_failure();
    ///
    ///     rec.set_time_duration_secs("time", 0.0);
    ///     rec.log("audio", rerun::AssetAudio::from_file_path(path).value_or_throw());
    /// }
    /// ```
    ///
    /// ⚠ **This type is _unstable_ and may change significantly in a way that the data won't be backwards compatible.**
    ///
    struct AssetAudio {
        /// The asset's bytes.
        std::optional<ComponentBatch> blob;
 
        /// The Media Type of the asset.
        ///
        /// For instance:
        /// * `audio/aac` (raw ADTS stream)
        /// * `audio/flac`
        /// * `audio/mp4` (M4A)
        /// * `audio/mpeg` (MP3)
        /// * `audio/ogg`
        /// * `audio/wav`
        ///
        /// Any audio media type can be stored.
        /// Which ones the viewer can decode depends on the viewer version.
        ///
        /// If omitted, the viewer will try to guess from the data blob.
        /// If it cannot guess, it won't be able to play the asset.
        std::optional<ComponentBatch> media_type;
 
      public:
        /// The name of the archetype as used in `ComponentDescriptor`s.
        static constexpr const char ArchetypeName[] = "rerun.archetypes.AssetAudio";
 
        /// `ComponentDescriptor` for the `blob` field.
        static constexpr auto Descriptor_blob = ComponentDescriptor(
            ArchetypeName, "AssetAudio:blob", Loggable<rerun::components::Blob>::ComponentType
        );
        /// `ComponentDescriptor` for the `media_type` field.
        static constexpr auto Descriptor_media_type = ComponentDescriptor(
            ArchetypeName, "AssetAudio:media_type",
            Loggable<rerun::components::MediaType>::ComponentType
        );
 
      public: // START of extensions from asset_audio_ext.cpp:
        /// Creates a new `AssetAudio` from the file contents at `path`.
        ///
        /// The `MediaType` will be guessed from the file extension.
        ///
        /// If no `MediaType` can be guessed at the moment, the Rerun Viewer will try to guess one
        /// from the data at playback-time. If it can't, playback will fail with an error.
        static Result<AssetAudio> from_file_path(const std::filesystem::path& path);
 
        /// Creates a new `AssetAudio` from the given `bytes`.
        ///
        /// If no `MediaType` is specified, the Rerun Viewer will try to guess one from the data
        /// at playback-time. If it can't, playback will fail with an error.
        static AssetAudio from_file_contents(
            rerun::Collection<uint8_t> bytes,
            std::optional<rerun::components::MediaType> media_type = {}
        ) {
            AssetAudio asset = AssetAudio(std::move(bytes));
            if (media_type.has_value()) {
                return std::move(asset).with_media_type(media_type.value());
            }
            return asset;
        }
 
        // END of extensions from asset_audio_ext.cpp, start of generated code:
 
      public:
        AssetAudio() = default;
        AssetAudio(AssetAudio&& other) = default;
        AssetAudio(const AssetAudio& other) = default;
        AssetAudio& operator=(const AssetAudio& other) = default;
        AssetAudio& operator=(AssetAudio&& other) = default;
 
        explicit AssetAudio(rerun::components::Blob _blob)
            : blob(ComponentBatch::from_loggable(std::move(_blob), Descriptor_blob).value_or_throw()
              ) {}
 
        /// Update only some specific fields of a `AssetAudio`.
        static AssetAudio update_fields() {
            return AssetAudio();
        }
 
        /// Clear all the fields of a `AssetAudio`.
        static AssetAudio clear_fields();
 
        /// The asset's bytes.
        AssetAudio with_blob(const rerun::components::Blob& _blob) && {
            blob = ComponentBatch::from_loggable(_blob, Descriptor_blob).value_or_throw();
            return std::move(*this);
        }
 
        /// This method makes it possible to pack multiple `blob` in a single component batch.
        ///
        /// This only makes sense when used in conjunction with `columns`. `with_blob` should
        /// be used when logging a single row's worth of data.
        AssetAudio with_many_blob(const Collection<rerun::components::Blob>& _blob) && {
            blob = ComponentBatch::from_loggable(_blob, Descriptor_blob).value_or_throw();
            return std::move(*this);
        }
 
        /// The Media Type of the asset.
        ///
        /// For instance:
        /// * `audio/aac` (raw ADTS stream)
        /// * `audio/flac`
        /// * `audio/mp4` (M4A)
        /// * `audio/mpeg` (MP3)
        /// * `audio/ogg`
        /// * `audio/wav`
        ///
        /// Any audio media type can be stored.
        /// Which ones the viewer can decode depends on the viewer version.
        ///
        /// If omitted, the viewer will try to guess from the data blob.
        /// If it cannot guess, it won't be able to play the asset.
        AssetAudio with_media_type(const rerun::components::MediaType& _media_type) && {
            media_type =
                ComponentBatch::from_loggable(_media_type, Descriptor_media_type).value_or_throw();
            return std::move(*this);
        }
 
        /// This method makes it possible to pack multiple `media_type` in a single component batch.
        ///
        /// This only makes sense when used in conjunction with `columns`. `with_media_type` should
        /// be used when logging a single row's worth of data.
        AssetAudio with_many_media_type(const Collection<rerun::components::MediaType>& _media_type
        ) && {
            media_type =
                ComponentBatch::from_loggable(_media_type, Descriptor_media_type).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::archetypes
 
namespace rerun {
    /// \private
    template <typename T>
    struct AsComponents;
 
    /// \private
    template <>
    struct AsComponents<archetypes::AssetAudio> {
        /// Serialize all set component batches.
        static Result<Collection<ComponentBatch>> as_batches(const archetypes::AssetAudio& archetype
        );
    };
} // namespace rerun