remote_data_track.h

/*
 * Copyright 2026 LiveKit
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
 
#pragma once
 
#include <cstdint>
#include <memory>
#include <optional>
#include <string>
 
#include "livekit/data_track_error.h"
#include "livekit/data_track_info.h"
#include "livekit/data_track_stream.h"
#include "livekit/ffi_handle.h"
#include "livekit/result.h"
#include "livekit/visibility.h"
 
namespace livekit {
 
namespace proto {
class OwnedRemoteDataTrack;
}
 
struct DataTrackPipelineOptions {
  std::optional<std::uint32_t> max_partial_frames{std::nullopt};
};
 
class RemoteDataTrack {
public:
  ~RemoteDataTrack() = default;
 
  RemoteDataTrack(const RemoteDataTrack&) = delete;
  RemoteDataTrack& operator=(const RemoteDataTrack&) = delete;
 
  const DataTrackInfo& info() const noexcept { return info_; }
 
  const std::string& publisherIdentity() const noexcept { return publisher_identity_; }
 
  LIVEKIT_API bool isPublished() const;
 
  LIVEKIT_API void setPipelineOptions(const DataTrackPipelineOptions& options);
 
#ifdef LIVEKIT_TEST_ACCESS
  uintptr_t testFfiHandleId() const noexcept { return ffiHandleId(); }
#endif
 
  LIVEKIT_API Result<std::shared_ptr<DataTrackStream>, SubscribeDataTrackError> subscribe(
      const DataTrackStream::Options& options = {});
 
private:
  friend class Room;
 
  explicit RemoteDataTrack(const proto::OwnedRemoteDataTrack& owned);
 
  uintptr_t ffiHandleId() const noexcept { return handle_.get(); }
  FfiHandle handle_;
 
  DataTrackInfo info_;
 
  std::string publisher_identity_;
};
 
} // namespace livekit