Roc Toolkit internal modules
Roc Toolkit: real-time audio streaming
Loading...
Searching...
No Matches
roc::pipeline::SenderSlot Class Reference

Sender slot. More...

#include <sender_slot.h>

Inheritance diagram for roc::pipeline::SenderSlot:
roc::core::RefCounted< SenderSlot, core::StandardAllocation > roc::core::ListNode roc::core::NonCopyable< T > roc::core::StandardAllocation roc::core::NonCopyable< ListNode >

Public Member Functions

 SenderSlot (const SenderConfig &config, const rtp::FormatMap &format_map, audio::Fanout &fanout, packet::PacketFactory &packet_factory, core::BufferFactory< uint8_t > &byte_buffer_factory, core::BufferFactory< audio::sample_t > &sample_buffer_factory, core::IAllocator &allocator)
 Initialize.
 
SenderEndpointcreate_endpoint (address::Interface iface, address::Protocol proto)
 Add endpoint.
 
audio::IFrameWriterwriter ()
 Get audio writer.
 
bool is_ready () const
 Check if slot configuration is done.
 
core::nanoseconds_t get_update_deadline () const
 Get deadline when the pipeline should be updated.
 
void update ()
 Update pipeline.
 
- Public Member Functions inherited from roc::core::RefCounted< SenderSlot, core::StandardAllocation >
 RefCounted ()
 Initialization with default allocation policy.
 
 RefCounted (const core::StandardAllocation &policy)
 Initialization with arbitrary allocation policy.
 
long getref () const
 Get reference counter.
 
void incref () const
 Increment reference counter.
 
void decref () const
 Decrement reference counter.
 
- Public Member Functions inherited from roc::core::ListNode
ListNodeDatalist_node_data () const
 Get list node data.
 

Additional Inherited Members

- Protected Member Functions inherited from roc::core::StandardAllocation
IAllocatorallocator () const
 Get allocator.
 
 StandardAllocation ()
 Initialize in invalid state. Such instance wont be usable.
 
 StandardAllocation (IAllocator &allocator)
 Initialize with given allocator. Such instance will use allocator to destroy objects.
 
template<class T >
void destroy (T &object)
 Destroy object and deallocate its memory.
 

Detailed Description

Sender slot.

Contains:

  • one or more related sender endpoints, one per each type
  • one session associated with those endpoints

Definition at line 36 of file sender_slot.h.

Constructor & Destructor Documentation

◆ SenderSlot()

roc::pipeline::SenderSlot::SenderSlot ( const SenderConfig config,
const rtp::FormatMap format_map,
audio::Fanout fanout,
packet::PacketFactory packet_factory,
core::BufferFactory< uint8_t > &  byte_buffer_factory,
core::BufferFactory< audio::sample_t > &  sample_buffer_factory,
core::IAllocator allocator 
)

Initialize.

Member Function Documentation

◆ create_endpoint()

SenderEndpoint * roc::pipeline::SenderSlot::create_endpoint ( address::Interface  iface,
address::Protocol  proto 
)

Add endpoint.

◆ get_update_deadline()

core::nanoseconds_t roc::pipeline::SenderSlot::get_update_deadline ( ) const

Get deadline when the pipeline should be updated.

◆ is_ready()

bool roc::pipeline::SenderSlot::is_ready ( ) const

Check if slot configuration is done.

◆ update()

void roc::pipeline::SenderSlot::update ( )

Update pipeline.

◆ writer()

audio::IFrameWriter * roc::pipeline::SenderSlot::writer ( )

Get audio writer.

Returns
NULL if slot is not ready.

The documentation for this class was generated from the following file: