## On this page

  

 

 # ensight\_grpc.EnSightGRPC Class Reference

 Last update: 16.07.2025 

Inheritance diagram for ensight_grpc.EnSightGRPC:

 ![](/sites/default/files/migrate-content/post_processing_tools_2024_r1/classensight__grpc_1_1_en_sight_g_r_p_c.png)



## <a id="pub-methods" name="pub-methods"></a>Public Member Functions

def [\_\_init\_\_](classensight__grpc_1_1_en_sight_g_r_p_c.xhtml#a8ee6669d7985844654e2bbf9424f8f78) (self, [port](classensight__grpc_1_1_en_sight_g_r_p_c.xhtml#aba8a316de83d60d8e336d5aa0c6b81b9)=12345, [host](classensight__grpc_1_1_en_sight_g_r_p_c.xhtml#a8636a0a4c5cd251a170e5a74062a85ad)='127.0.0.1', version='') def [host](classensight__grpc_1_1_en_sight_g_r_p_c.xhtml#a8636a0a4c5cd251a170e5a74062a85ad) (self) def [port](classensight__grpc_1_1_en_sight_g_r_p_c.xhtml#aba8a316de83d60d8e336d5aa0c6b81b9) (self) def [set\_security\_token](classensight__grpc_1_1_en_sight_g_r_p_c.xhtml#a486d4c52d83f0e87bc3597eb9c9e5be8) (self, n) def [security\_token](classensight__grpc_1_1_en_sight_g_r_p_c.xhtml#a77a79eaefba2c31fe9c0fb79cfce33ec) (self) def [shutdown](classensight__grpc_1_1_en_sight_g_r_p_c.xhtml#a5ddd86d9e961a5877d2bd7bbf5dc00be) (self) def [start\_server](classensight__grpc_1_1_en_sight_g_r_p_c.xhtml#a67ce94a9e4e719738045e46995a7d2bc) (self) def [stop\_server](classensight__grpc_1_1_en_sight_g_r_p_c.xhtml#aa4eebb244cc65980a49641277f44e335) (self) def [is\_connected](classensight__grpc_1_1_en_sight_g_r_p_c.xhtml#a8fc7d16e77608ebf9fac994cfe6c6962) (self) def [connect](classensight__grpc_1_1_en_sight_g_r_p_c.xhtml#a159a6958683fa9a20a2ec0dc6b042d64) (self, timeout=15.0) def [render](classensight__grpc_1_1_en_sight_g_r_p_c.xhtml#a84d1219b2212bd20046fbbad4e8d3a16) (self, width=640, height=480, aa=1, raw=False, highlighting=False) def [geometry](classensight__grpc_1_1_en_sight_g_r_p_c.xhtml#aceff36a440081a2bd9883e06c8aad3e9) (self) def [command](classensight__grpc_1_1_en_sight_g_r_p_c.xhtml#aee5e90993ebefa99fdfa52abf58678cd) (self, command\_string, do\_eval=True, json=False, raw\_eval=False) def [image\_stream\_enable](classensight__grpc_1_1_en_sight_g_r_p_c.xhtml#a1b458ced85e5762a65f6350bb44d4663) (self, flip\_vertical=False) def [get\_image](classensight__grpc_1_1_en_sight_g_r_p_c.xhtml#a7c97a3695f88cca927e038db0a89166b) (self) def [image\_stream\_is\_enabled](classensight__grpc_1_1_en_sight_g_r_p_c.xhtml#a4c9628794a89801fb2755e8b83275409) (self) def [prefix](classensight__grpc_1_1_en_sight_g_r_p_c.xhtml#a07c8395c90161e48c4c87fa44fa75dd5) (self) def [event\_stream\_enable](classensight__grpc_1_1_en_sight_g_r_p_c.xhtml#a4c94dde7598246594541e30ffb889e67) (self, callback=None, [prefix](classensight__grpc_1_1_en_sight_g_r_p_c.xhtml#a07c8395c90161e48c4c87fa44fa75dd5)=None) def [dynamic\_scene\_graph\_stream](classensight__grpc_1_1_en_sight_g_r_p_c.xhtml#af0b01c8104a2c8424352c03156295446) (self, client\_cmds) def [event\_stream\_is\_enabled](classensight__grpc_1_1_en_sight_g_r_p_c.xhtml#a257fac6f7ebc52f5590052ce5e26bf1a) (self) def [get\_event](classensight__grpc_1_1_en_sight_g_r_p_c.xhtml#ae9476edbbeb3f2c866b406d6f49a878d) (self) def [subscribe\_events](classensight__grpc_1_1_en_sight_g_r_p_c.xhtml#a5c37ea23b40c16cea4dcce1fa4168ff9) (self) def [subscribe\_images](classensight__grpc_1_1_en_sight_g_r_p_c.xhtml#aa302bfab5b17ea395432a153c264e823) (self, flip\_vertical=False, use\_shmem=True) def [unsubscribe](classensight__grpc_1_1_en_sight_g_r_p_c.xhtml#a7987c8afd724e4474091050ff177dcde) (self) ## <a id="pro-attribs" name="pro-attribs"></a>Protected Attributes

 [\_host](classensight__grpc_1_1_en_sight_g_r_p_c.xhtml#acfa730cfcb568cc26f079996804ebb97)  [\_port](classensight__grpc_1_1_en_sight_g_r_p_c.xhtml#a3288be89c9ab636283cb59df9fe0dc17)  [\_pid](classensight__grpc_1_1_en_sight_g_r_p_c.xhtml#abba6d94b9acc418d610e900aecbfd23c)  [\_channel](classensight__grpc_1_1_en_sight_g_r_p_c.xhtml#abb7212c7e4ad9e7ef398bf5e13f15fb8)  [\_stub](classensight__grpc_1_1_en_sight_g_r_p_c.xhtml#a8d6e08882d55ce3c7fbd837bedfc0d98)  [\_dsg\_stub](classensight__grpc_1_1_en_sight_g_r_p_c.xhtml#a44561d8bec5adfc5fe51978b5f4dd6fb)  [\_version](classensight__grpc_1_1_en_sight_g_r_p_c.xhtml#a4ed120bd2b7a2a477bf0c19dc1765fce)  [\_security\_token](classensight__grpc_1_1_en_sight_g_r_p_c.xhtml#aec4f4d61de4dfe799e620a005945a016)  [\_image\_stream](classensight__grpc_1_1_en_sight_g_r_p_c.xhtml#aefa2e7fffb9d88723e08ca8a17b56b62)  [\_image\_thread](classensight__grpc_1_1_en_sight_g_r_p_c.xhtml#a371afc6dc33f0d9fab188aa758c3cafb)  [\_image](classensight__grpc_1_1_en_sight_g_r_p_c.xhtml#a6e8208612ce6492e8702f0fcdfe32901)  [\_image\_number](classensight__grpc_1_1_en_sight_g_r_p_c.xhtml#ab320bc03c41789180117beac3b94154f)  [\_shmem\_client](classensight__grpc_1_1_en_sight_g_r_p_c.xhtml#a7cc44f4eb01c9bfe14a17d01dc8d8d36)  [\_shmem\_filename](classensight__grpc_1_1_en_sight_g_r_p_c.xhtml#afb65fb2ac55da0dfc23022eb188656fc)  [\_event\_stream](classensight__grpc_1_1_en_sight_g_r_p_c.xhtml#ade63e1260b8690a73b72f2d65b561096)  [\_event\_thread](classensight__grpc_1_1_en_sight_g_r_p_c.xhtml#a98f82222b0e4dcbf23f28ed20168a94e)  [\_events](classensight__grpc_1_1_en_sight_g_r_p_c.xhtml#ac385f5b18232bcec204b028221602427)  [\_prefix](classensight__grpc_1_1_en_sight_g_r_p_c.xhtml#ab95ca5fcf1061b71a5d16f562995c7d0)  [\_sub\_service](classensight__grpc_1_1_en_sight_g_r_p_c.xhtml#aa94401a916262c38e1173cca04c9390c)  [\_event\_callback](classensight__grpc_1_1_en_sight_g_r_p_c.xhtml#a54868c3a59ac189e258285885a48f65e) <a id="details" name="details"></a>## Detailed Description

This class provides an asynchronous interface to the EnSight core gRPC interface. It can handle remote image and event streams, providing a much simpler interface to the EnSight application

Definition at line [35](ensight__grpc_8py_source.xhtml#l00035) of file [ensight\_grpc.py](ensight__grpc_8py_source.xhtml).



## Constructor &amp; Destructor Documentation

<a id="a8ee6669d7985844654e2bbf9424f8f78" name="a8ee6669d7985844654e2bbf9424f8f78"></a>## [◆ ](#a8ee6669d7985844654e2bbf9424f8f78)\_\_init\_\_()

 def ensight\_grpc.EnSightGRPC.\_\_init\_\_  (   *self*,      *port* = `12345`,      *host* = `'127.0.0.1'`,      *version* = `''`   ) 

create an instance of the EnSight gRPC interface wrapper

The default is to make a connection to an EnSight gRPC server on port 12345 on the loopback host. If requested to launch the server, it will be the current version.

Parameters portThe port number of the EnSight gRPC server hostThe hostname of the EnSight gRPC server versionA specific EnSight version number to run (e.g. '222' for 2022R2) Definition at line [45](ensight__grpc_8py_source.xhtml#l00045) of file [ensight\_grpc.py](ensight__grpc_8py_source.xhtml).





## Member Function Documentation

<a id="aee5e90993ebefa99fdfa52abf58678cd" name="aee5e90993ebefa99fdfa52abf58678cd"></a>## [◆ ](#aee5e90993ebefa99fdfa52abf58678cd)command()

 def ensight\_grpc.EnSightGRPC.command  (   *self*,      *command\_string*,      *do\_eval* = `True`,      *json* = `False`,      *raw\_eval* = `False`   ) 

send a Python command string to be executed in EnSight

The string will be run or evaluated in the EnSight Python interpreter via the EnSightService::RunPython() gRPC all. If an exception or other error occurs, this function will throw a RuntimeError. If do\_eval is False, the return value will be None, otherwise it will be the result of eval() of the string.

Parameters command\_stringthe string to be executed do\_evalif True, the string will be run via "eval()" and the results returned jsonIf true, the value returned with do\_eval() will be encoded via json, otherwise it will be a Python object Definition at line [254](ensight__grpc_8py_source.xhtml#l00254) of file [ensight\_grpc.py](ensight__grpc_8py_source.xhtml).





<a id="a159a6958683fa9a20a2ec0dc6b042d64" name="a159a6958683fa9a20a2ec0dc6b042d64"></a>## [◆ ](#a159a6958683fa9a20a2ec0dc6b042d64)connect()

 def ensight\_grpc.EnSightGRPC.connect  (   *self*,      *timeout* = `15.0`   ) 

establish a connection to an EnSight gRPC server

Attempt to connect to an EnSight gRPC server using the host and port established by the constructor. Note on failure, this function just returns, but is\_connected() will return False.

Parameters timeouthow long to wait for the connection to timeout. Definition at line [177](ensight__grpc_8py_source.xhtml#l00177) of file [ensight\_grpc.py](ensight__grpc_8py_source.xhtml).





<a id="af0b01c8104a2c8424352c03156295446" name="af0b01c8104a2c8424352c03156295446"></a>## [◆ ](#af0b01c8104a2c8424352c03156295446)dynamic\_scene\_graph\_stream()

 def ensight\_grpc.EnSightGRPC.dynamic\_scene\_graph\_stream  (   *self*,      *client\_cmds*   ) 

open up a dynamic scene graph stream

Make a DynamicSceneGraphService::GetSceneStream() rpc call and return a [ensightservice::SceneUpdateCommand](structensightservice_1_1_scene_update_command.xhtml "Aggregate command sent by EnSight to a client.") stream instance.

Parameters client\_cmdsan iterator that produces [ensightservice::SceneClientCommand](structensightservice_1_1_scene_client_command.xhtml "Aggregate command sent by a dynamic scene graph client.") objects Returnsa [ensightservice::SceneUpdateCommand](structensightservice_1_1_scene_update_command.xhtml "Aggregate command sent by EnSight to a client.") stream instance Definition at line [396](ensight__grpc_8py_source.xhtml#l00396) of file [ensight\_grpc.py](ensight__grpc_8py_source.xhtml).





<a id="a4c94dde7598246594541e30ffb889e67" name="a4c94dde7598246594541e30ffb889e67"></a>## [◆ ](#a4c94dde7598246594541e30ffb889e67)event\_stream\_enable()

 def ensight\_grpc.EnSightGRPC.event\_stream\_enable  (   *self*,      *callback* = `None`,      *prefix* = `None`   ) 

enable a simple gRPC-based event stream from EnSight

This method makes a EnSightService::GetEventStream() gRPC call into EnSight, returning an [ensightservice::EventReply](structensightservice_1_1_event_reply.xhtml) stream. The method creates a thread to hold this stream open and read new events from it. The thread adds the event strings to a list of events stored on this instance. If callback is not None, the object will be called with the event string, otherwise they can be retrieved using get\_event().

Definition at line [376](ensight__grpc_8py_source.xhtml#l00376) of file [ensight\_grpc.py](ensight__grpc_8py_source.xhtml).





<a id="a257fac6f7ebc52f5590052ce5e26bf1a" name="a257fac6f7ebc52f5590052ce5e26bf1a"></a>## [◆ ](#a257fac6f7ebc52f5590052ce5e26bf1a)event\_stream\_is\_enabled()

 def ensight\_grpc.EnSightGRPC.event\_stream\_is\_enabled  (   *self*) 

check to see if the event stream is enabled

If an event stream has been successfully established via event\_stream\_enable(), then this function returns True

ReturnsTrue if a [ensightservice::EventReply](structensightservice_1_1_event_reply.xhtml) steam is active Definition at line [405](ensight__grpc_8py_source.xhtml#l00405) of file [ensight\_grpc.py](ensight__grpc_8py_source.xhtml).





<a id="aceff36a440081a2bd9883e06c8aad3e9" name="aceff36a440081a2bd9883e06c8aad3e9"></a>## [◆ ](#aceff36a440081a2bd9883e06c8aad3e9)geometry()

 def ensight\_grpc.EnSightGRPC.geometry  (   *self*) 

return the current scene geometry in glTF format

Package up the geometry currently being viewed in the EnSight session as a glTF stream. Return this stream as an array of byte. Note: no interrmediate files are utilized.

Definition at line [235](ensight__grpc_8py_source.xhtml#l00235) of file [ensight\_grpc.py](ensight__grpc_8py_source.xhtml).





<a id="ae9476edbbeb3f2c866b406d6f49a878d" name="ae9476edbbeb3f2c866b406d6f49a878d"></a>## [◆ ](#ae9476edbbeb3f2c866b406d6f49a878d)get\_event()

 def ensight\_grpc.EnSightGRPC.get\_event  (   *self*) 

retrieve and remove the oldest [ensightservice::EventReply](structensightservice_1_1_event_reply.xhtml) string

When any of the event streaming systems is enabled, Python threads will receive the event records and store them in this instance in an ordered fashion. This method retrieves the oldest [ensightservice::EventReply](structensightservice_1_1_event_reply.xhtml) string in the queue.

Returnsthe even string or None if no events are available Definition at line [415](ensight__grpc_8py_source.xhtml#l00415) of file [ensight\_grpc.py](ensight__grpc_8py_source.xhtml).





<a id="a7c97a3695f88cca927e038db0a89166b" name="a7c97a3695f88cca927e038db0a89166b"></a>## [◆ ](#a7c97a3695f88cca927e038db0a89166b)get\_image()

 def ensight\_grpc.EnSightGRPC.get\_image  (   *self*) 

retrieve the current EnSight image

When any of the image streaming systems is enabled, Python threads will receive the most recent image and store them in this instance. The frame stored in this instance can be accessed by calling this method

Returnsthe image dict(pixels=bytearray, width=w, height=h) and the image frame number Definition at line [302](ensight__grpc_8py_source.xhtml#l00302) of file [ensight\_grpc.py](ensight__grpc_8py_source.xhtml).





<a id="a8636a0a4c5cd251a170e5a74062a85ad" name="a8636a0a4c5cd251a170e5a74062a85ad"></a>## [◆ ](#a8636a0a4c5cd251a170e5a74062a85ad)host()

 def ensight\_grpc.EnSightGRPC.host  (   *self*) 

get the hostname for this connection

Returns the current connection hostname.

Definition at line [74](ensight__grpc_8py_source.xhtml#l00074) of file [ensight\_grpc.py](ensight__grpc_8py_source.xhtml).





<a id="a1b458ced85e5762a65f6350bb44d4663" name="a1b458ced85e5762a65f6350bb44d4663"></a>## [◆ ](#a1b458ced85e5762a65f6350bb44d4663)image\_stream\_enable()

 def ensight\_grpc.EnSightGRPC.image\_stream\_enable  (   *self*,      *flip\_vertical* = `False`   ) 

enable a simple gRPC-based image stream from EnSight

This method makes a EnSightService::GetImageStream() gRPC call into EnSight, returning an [ensightservice::ImageReply](structensightservice_1_1_image_reply.xhtml "An image frame message.") stream. The method creates a thread to hold this stream open and read new image frames from it. The thread places the read images in this object. An external application can retrieve the most recent one using get\_image().

Parameters flip\_verticalIf True, the image will be flipped over the X axis before being sent from EnSight. Definition at line [284](ensight__grpc_8py_source.xhtml#l00284) of file [ensight\_grpc.py](ensight__grpc_8py_source.xhtml).





<a id="a4c9628794a89801fb2755e8b83275409" name="a4c9628794a89801fb2755e8b83275409"></a>## [◆ ](#a4c9628794a89801fb2755e8b83275409)image\_stream\_is\_enabled()

 def ensight\_grpc.EnSightGRPC.image\_stream\_is\_enabled  (   *self*) 

check to see if the image stream is enabled

If an image stream has been successfully established via image\_stream\_enable(), then this function returns True

ReturnsTrue if a [ensightservice::ImageReply](structensightservice_1_1_image_reply.xhtml "An image frame message.") steam is active Definition at line [354](ensight__grpc_8py_source.xhtml#l00354) of file [ensight\_grpc.py](ensight__grpc_8py_source.xhtml).





<a id="a8fc7d16e77608ebf9fac994cfe6c6962" name="a8fc7d16e77608ebf9fac994cfe6c6962"></a>## [◆ ](#a8fc7d16e77608ebf9fac994cfe6c6962)is\_connected()

 def ensight\_grpc.EnSightGRPC.is\_connected  (   *self*) 

check if a gRPC connection has been established

Returns True if a previous connect() call made a valid gRPC connection.

Definition at line [168](ensight__grpc_8py_source.xhtml#l00168) of file [ensight\_grpc.py](ensight__grpc_8py_source.xhtml).





<a id="aba8a316de83d60d8e336d5aa0c6b81b9" name="aba8a316de83d60d8e336d5aa0c6b81b9"></a>## [◆ ](#aba8a316de83d60d8e336d5aa0c6b81b9)port()

 def ensight\_grpc.EnSightGRPC.port  (   *self*) 

get the port number for this connection

Returns the current connection port number.

Definition at line [80](ensight__grpc_8py_source.xhtml#l00080) of file [ensight\_grpc.py](ensight__grpc_8py_source.xhtml).





<a id="a07c8395c90161e48c4c87fa44fa75dd5" name="a07c8395c90161e48c4c87fa44fa75dd5"></a>## [◆ ](#a07c8395c90161e48c4c87fa44fa75dd5)prefix()

 def ensight\_grpc.EnSightGRPC.prefix  (   *self*) 

return the unique prefix for this instance

Many of the EnSight gRPC APIs require a unique prefix so that EnSight can handle multiple, simultaneous remote connections. This method will generate a GUID-based prefix.

ReturnsA unique prefix string of the form: grpc://{uuid}/ Definition at line [363](ensight__grpc_8py_source.xhtml#l00363) of file [ensight\_grpc.py](ensight__grpc_8py_source.xhtml).





<a id="a84d1219b2212bd20046fbbad4e8d3a16" name="a84d1219b2212bd20046fbbad4e8d3a16"></a>## [◆ ](#a84d1219b2212bd20046fbbad4e8d3a16)render()

 def ensight\_grpc.EnSightGRPC.render  (   *self*,      *width* = `640`,      *height* = `480`,      *aa* = `1`,      *raw* = `False`,      *highlighting* = `False`   ) 

render the current EnSight screen and return the image

Render the current scene at some resolution independent of the current EnSight scene view.

Parameters widthwidth in pixels heightheight in pixels aanumber of anti-aliasing passes rawIf True, the returned array will be width\*height\*3 bytes in size. If False, it will be a byte array in PNG format. highlightingIf True, the current dynamic selection/highlighting will be in the image Definition at line [215](ensight__grpc_8py_source.xhtml#l00215) of file [ensight\_grpc.py](ensight__grpc_8py_source.xhtml).





<a id="a77a79eaefba2c31fe9c0fb79cfce33ec" name="a77a79eaefba2c31fe9c0fb79cfce33ec"></a>## [◆ ](#a77a79eaefba2c31fe9c0fb79cfce33ec)security\_token()

 def ensight\_grpc.EnSightGRPC.security\_token  (   *self*) 

return the security token for the gRPC connection.

Returns the current connection security token

Definition at line [98](ensight__grpc_8py_source.xhtml#l00098) of file [ensight\_grpc.py](ensight__grpc_8py_source.xhtml).





<a id="a486d4c52d83f0e87bc3597eb9c9e5be8" name="a486d4c52d83f0e87bc3597eb9c9e5be8"></a>## [◆ ](#a486d4c52d83f0e87bc3597eb9c9e5be8)set\_security\_token()

 def ensight\_grpc.EnSightGRPC.set\_security\_token  (   *self*,      *n*   ) 

set the security token for the gRPC connection.

EnSight supports a security token in either numeric (-security {int}) or string (ENSIGHT\_SECURITY\_TOKEN environmental variable) form. If EnSight is using a security token, all gRPC calls must include this token. This call sets the token for all rGPC calls made by this class. Note: for this module, the security token must be a in bytes() format. For example: str(1000).encode("utf-8")

Parameters nan string to be used as the security token Definition at line [92](ensight__grpc_8py_source.xhtml#l00092) of file [ensight\_grpc.py](ensight__grpc_8py_source.xhtml).





<a id="a5ddd86d9e961a5877d2bd7bbf5dc00be" name="a5ddd86d9e961a5877d2bd7bbf5dc00be"></a>## [◆ ](#a5ddd86d9e961a5877d2bd7bbf5dc00be)shutdown()

 def ensight\_grpc.EnSightGRPC.shutdown  (   *self*) 

shut down all gRPC connections

If this class launched the EnSight client instance, it will send the gRPC exit() call and then shut down all connections.

Definition at line [105](ensight__grpc_8py_source.xhtml#l00105) of file [ensight\_grpc.py](ensight__grpc_8py_source.xhtml).





<a id="a67ce94a9e4e719738045e46995a7d2bc" name="a67ce94a9e4e719738045e46995a7d2bc"></a>## [◆ ](#a67ce94a9e4e719738045e46995a7d2bc)start\_server()

 def ensight\_grpc.EnSightGRPC.start\_server  (   *self*) 

Start an EnSight gRPC server instance.

If the host application wishes to launch an EnSight instance, start\_server() will launch a batch mode EnSight application with the security token and a gRPC server started on the port passed in the constructor.

Definition at line [128](ensight__grpc_8py_source.xhtml#l00128) of file [ensight\_grpc.py](ensight__grpc_8py_source.xhtml).





<a id="aa4eebb244cc65980a49641277f44e335" name="aa4eebb244cc65980a49641277f44e335"></a>## [◆ ](#aa4eebb244cc65980a49641277f44e335)stop\_server()

 def ensight\_grpc.EnSightGRPC.stop\_server  (   *self*) 

shut down any gPRC connection made by this class

First, if this class launched the EnSight instance, via start\_server(), the exit() gRPC command will be sent. Second, the local gRPC connection is dropped.

Definition at line [153](ensight__grpc_8py_source.xhtml#l00153) of file [ensight\_grpc.py](ensight__grpc_8py_source.xhtml).





<a id="a5c37ea23b40c16cea4dcce1fa4168ff9" name="a5c37ea23b40c16cea4dcce1fa4168ff9"></a>## [◆ ](#a5c37ea23b40c16cea4dcce1fa4168ff9)subscribe\_events()

 def ensight\_grpc.EnSightGRPC.subscribe\_events  (   *self*) 

subscribe to an event stream using a locally launched gRPC server

This methond makes a EnSightService::SubscribeEvents() gRPC call, causing EnSight to make a reverse gRPC connection over with gRPC calls with the various events will be made.

Definition at line [471](ensight__grpc_8py_source.xhtml#l00471) of file [ensight\_grpc.py](ensight__grpc_8py_source.xhtml).





<a id="aa302bfab5b17ea395432a153c264e823" name="aa302bfab5b17ea395432a153c264e823"></a>## [◆ ](#aa302bfab5b17ea395432a153c264e823)subscribe\_images()

 def ensight\_grpc.EnSightGRPC.subscribe\_images  (   *self*,      *flip\_vertical* = `False`,      *use\_shmem* = `True`   ) 

subscribe to an image stream

This methond makes a EnSightService::SubscribeImages() gRPC call. If use\_shmem is False, the transport system will be made over gRPC. It causes EnSight to make a reverse gRPC connection over with gRPC calls with the various images will be made. If use\_shmem is True (the default), the [EnSight gRPC Shared Memory Image Transport API](group__shmem.xhtml) will be used.

Parameters flip\_verticalIf True, the image pixels will be flipped over the X axis use\_shmemIf True, use the shared memory transport, otherwise use reverse gRPC Definition at line [488](ensight__grpc_8py_source.xhtml#l00488) of file [ensight\_grpc.py](ensight__grpc_8py_source.xhtml).





<a id="a7987c8afd724e4474091050ff177dcde" name="a7987c8afd724e4474091050ff177dcde"></a>## [◆ ](#a7987c8afd724e4474091050ff177dcde)unsubscribe()

 def ensight\_grpc.EnSightGRPC.unsubscribe  (   *self*) 

unsubscribe from any image or event streams that have been subscribed to

This method makes a EnSightService::Unsubscribe() gRPC call. It will cancel any subscribe\_events() or subscribe\_images() calls.

Definition at line [527](ensight__grpc_8py_source.xhtml#l00527) of file [ensight\_grpc.py](ensight__grpc_8py_source.xhtml).





## Member Data Documentation

<a id="abb7212c7e4ad9e7ef398bf5e13f15fb8" name="abb7212c7e4ad9e7ef398bf5e13f15fb8"></a>## [◆ ](#abb7212c7e4ad9e7ef398bf5e13f15fb8)\_channel

 ensight\_grpc.EnSightGRPC.\_channel  protected 

Definition at line [49](ensight__grpc_8py_source.xhtml#l00049) of file [ensight\_grpc.py](ensight__grpc_8py_source.xhtml).





<a id="a44561d8bec5adfc5fe51978b5f4dd6fb" name="a44561d8bec5adfc5fe51978b5f4dd6fb"></a>## [◆ ](#a44561d8bec5adfc5fe51978b5f4dd6fb)\_dsg\_stub

 ensight\_grpc.EnSightGRPC.\_dsg\_stub  protected 

Definition at line [51](ensight__grpc_8py_source.xhtml#l00051) of file [ensight\_grpc.py](ensight__grpc_8py_source.xhtml).





<a id="a54868c3a59ac189e258285885a48f65e" name="a54868c3a59ac189e258285885a48f65e"></a>## [◆ ](#a54868c3a59ac189e258285885a48f65e)\_event\_callback

 ensight\_grpc.EnSightGRPC.\_event\_callback  protected 

Definition at line [68](ensight__grpc_8py_source.xhtml#l00068) of file [ensight\_grpc.py](ensight__grpc_8py_source.xhtml).





<a id="ade63e1260b8690a73b72f2d65b561096" name="ade63e1260b8690a73b72f2d65b561096"></a>## [◆ ](#ade63e1260b8690a73b72f2d65b561096)\_event\_stream

 ensight\_grpc.EnSightGRPC.\_event\_stream  protected 

Definition at line [63](ensight__grpc_8py_source.xhtml#l00063) of file [ensight\_grpc.py](ensight__grpc_8py_source.xhtml).





<a id="a98f82222b0e4dcbf23f28ed20168a94e" name="a98f82222b0e4dcbf23f28ed20168a94e"></a>## [◆ ](#a98f82222b0e4dcbf23f28ed20168a94e)\_event\_thread

 ensight\_grpc.EnSightGRPC.\_event\_thread  protected 

Definition at line [64](ensight__grpc_8py_source.xhtml#l00064) of file [ensight\_grpc.py](ensight__grpc_8py_source.xhtml).





<a id="ac385f5b18232bcec204b028221602427" name="ac385f5b18232bcec204b028221602427"></a>## [◆ ](#ac385f5b18232bcec204b028221602427)\_events

 ensight\_grpc.EnSightGRPC.\_events  protected 

Definition at line [65](ensight__grpc_8py_source.xhtml#l00065) of file [ensight\_grpc.py](ensight__grpc_8py_source.xhtml).





<a id="acfa730cfcb568cc26f079996804ebb97" name="acfa730cfcb568cc26f079996804ebb97"></a>## [◆ ](#acfa730cfcb568cc26f079996804ebb97)\_host

 ensight\_grpc.EnSightGRPC.\_host  protected 

Definition at line [46](ensight__grpc_8py_source.xhtml#l00046) of file [ensight\_grpc.py](ensight__grpc_8py_source.xhtml).





<a id="a6e8208612ce6492e8702f0fcdfe32901" name="a6e8208612ce6492e8702f0fcdfe32901"></a>## [◆ ](#a6e8208612ce6492e8702f0fcdfe32901)\_image

 ensight\_grpc.EnSightGRPC.\_image  protected 

Definition at line [58](ensight__grpc_8py_source.xhtml#l00058) of file [ensight\_grpc.py](ensight__grpc_8py_source.xhtml).





<a id="ab320bc03c41789180117beac3b94154f" name="ab320bc03c41789180117beac3b94154f"></a>## [◆ ](#ab320bc03c41789180117beac3b94154f)\_image\_number

 ensight\_grpc.EnSightGRPC.\_image\_number  protected 

Definition at line [59](ensight__grpc_8py_source.xhtml#l00059) of file [ensight\_grpc.py](ensight__grpc_8py_source.xhtml).





<a id="aefa2e7fffb9d88723e08ca8a17b56b62" name="aefa2e7fffb9d88723e08ca8a17b56b62"></a>## [◆ ](#aefa2e7fffb9d88723e08ca8a17b56b62)\_image\_stream

 ensight\_grpc.EnSightGRPC.\_image\_stream  protected 

Definition at line [56](ensight__grpc_8py_source.xhtml#l00056) of file [ensight\_grpc.py](ensight__grpc_8py_source.xhtml).





<a id="a371afc6dc33f0d9fab188aa758c3cafb" name="a371afc6dc33f0d9fab188aa758c3cafb"></a>## [◆ ](#a371afc6dc33f0d9fab188aa758c3cafb)\_image\_thread

 ensight\_grpc.EnSightGRPC.\_image\_thread  protected 

Definition at line [57](ensight__grpc_8py_source.xhtml#l00057) of file [ensight\_grpc.py](ensight__grpc_8py_source.xhtml).





<a id="abba6d94b9acc418d610e900aecbfd23c" name="abba6d94b9acc418d610e900aecbfd23c"></a>## [◆ ](#abba6d94b9acc418d610e900aecbfd23c)\_pid

 ensight\_grpc.EnSightGRPC.\_pid  protected 

Definition at line [48](ensight__grpc_8py_source.xhtml#l00048) of file [ensight\_grpc.py](ensight__grpc_8py_source.xhtml).





<a id="a3288be89c9ab636283cb59df9fe0dc17" name="a3288be89c9ab636283cb59df9fe0dc17"></a>## [◆ ](#a3288be89c9ab636283cb59df9fe0dc17)\_port

 ensight\_grpc.EnSightGRPC.\_port  protected 

Definition at line [47](ensight__grpc_8py_source.xhtml#l00047) of file [ensight\_grpc.py](ensight__grpc_8py_source.xhtml).





<a id="ab95ca5fcf1061b71a5d16f562995c7d0" name="ab95ca5fcf1061b71a5d16f562995c7d0"></a>## [◆ ](#ab95ca5fcf1061b71a5d16f562995c7d0)\_prefix

 ensight\_grpc.EnSightGRPC.\_prefix  protected 

Definition at line [66](ensight__grpc_8py_source.xhtml#l00066) of file [ensight\_grpc.py](ensight__grpc_8py_source.xhtml).





<a id="aec4f4d61de4dfe799e620a005945a016" name="aec4f4d61de4dfe799e620a005945a016"></a>## [◆ ](#aec4f4d61de4dfe799e620a005945a016)\_security\_token

 ensight\_grpc.EnSightGRPC.\_security\_token  protected 

Definition at line [53](ensight__grpc_8py_source.xhtml#l00053) of file [ensight\_grpc.py](ensight__grpc_8py_source.xhtml).





<a id="a7cc44f4eb01c9bfe14a17d01dc8d8d36" name="a7cc44f4eb01c9bfe14a17d01dc8d8d36"></a>## [◆ ](#a7cc44f4eb01c9bfe14a17d01dc8d8d36)\_shmem\_client

 ensight\_grpc.EnSightGRPC.\_shmem\_client  protected 

Definition at line [60](ensight__grpc_8py_source.xhtml#l00060) of file [ensight\_grpc.py](ensight__grpc_8py_source.xhtml).





<a id="afb65fb2ac55da0dfc23022eb188656fc" name="afb65fb2ac55da0dfc23022eb188656fc"></a>## [◆ ](#afb65fb2ac55da0dfc23022eb188656fc)\_shmem\_filename

 ensight\_grpc.EnSightGRPC.\_shmem\_filename  protected 

Definition at line [61](ensight__grpc_8py_source.xhtml#l00061) of file [ensight\_grpc.py](ensight__grpc_8py_source.xhtml).





<a id="a8d6e08882d55ce3c7fbd837bedfc0d98" name="a8d6e08882d55ce3c7fbd837bedfc0d98"></a>## [◆ ](#a8d6e08882d55ce3c7fbd837bedfc0d98)\_stub

 ensight\_grpc.EnSightGRPC.\_stub  protected 

Definition at line [50](ensight__grpc_8py_source.xhtml#l00050) of file [ensight\_grpc.py](ensight__grpc_8py_source.xhtml).





<a id="aa94401a916262c38e1173cca04c9390c" name="aa94401a916262c38e1173cca04c9390c"></a>## [◆ ](#aa94401a916262c38e1173cca04c9390c)\_sub\_service

 ensight\_grpc.EnSightGRPC.\_sub\_service  protected 

Definition at line [67](ensight__grpc_8py_source.xhtml#l00067) of file [ensight\_grpc.py](ensight__grpc_8py_source.xhtml).





<a id="a4ed120bd2b7a2a477bf0c19dc1765fce" name="a4ed120bd2b7a2a477bf0c19dc1765fce"></a>## [◆ ](#a4ed120bd2b7a2a477bf0c19dc1765fce)\_version

 ensight\_grpc.EnSightGRPC.\_version  protected 

Definition at line [52](ensight__grpc_8py_source.xhtml#l00052) of file [ensight\_grpc.py](ensight__grpc_8py_source.xhtml).





---

The documentation for this class was generated from the following file:- D:/Product-src/ensight/client/rpc\_interface/[ensight\_grpc.py](ensight__grpc_8py_source.xhtml)