unreal.LiveLinkMessageBusFinder

class unreal.LiveLinkMessageBusFinder(outer=None, name='None')

Bases: unreal.Object

Asset for finding available Message Bus Sources.

C++ Source:

  • Plugin: LiveLink
  • Module: LiveLink
  • File: LiveLinkMessageBusFinder.h
classmethod connect_to_provider(provider) -> (provider=ProviderPollResult, source_handle=LiveLinkSourceHandle)
  • Connects to a given Message Bus Provider and returns a handle to the created LiveLink Source
Parameters:provider (ProviderPollResult) – The provider to connect to. *
Returns:provider (ProviderPollResult):

source_handle (LiveLinkSourceHandle): A handle to the created LiveLink Source, lets you query information about the created source and request a shutdown

Return type:tuple
classmethod construct_message_bus_finder() → LiveLinkMessageBusFinder
  • Constructs a new Message Bus Finder which enables you to detect available Message Bus Providers on the network
Returns:The newly constructed Message Bus Finder
Return type:LiveLinkMessageBusFinder
get_available_providers(world_context_object, latent_info, duration) -> Array(ProviderPollResult)
  • Broadcasts a message to the network and returns a list of all providers who replied within a set amount of time.
Parameters:
  • world_context_object (Object) –
  • latent_info (LatentActionInfo) –
  • duration (float) – The amount of time to wait for replies in seconds
Returns:

available_providers (Array(ProviderPollResult)): Will contain the collection of found Message Bus Providers. *

Return type:

Array(ProviderPollResult)