matthew/ostinato
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

sign: Expand getStreamStatsDict() documentation

Browse Source
This commit is contained in:
Srivats P 2017-01-05 20:26:21 +05:30
parent 416292e42b
commit 063c607847
1 changed files with 7 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
binding/core.py
View File

@ -69,9 +69,13 @@ class DroneProxy(object):
def getStreamStatsDict(self, stream_guid_list): # FIXME: rename? def getStreamStatsDict(self, stream_guid_list): # FIXME: rename?
""" """
Convenience wrapper method for getStreamStats which returns StreamStats Convenience method for fetching stream stats which returns an object
as a dictionary instead of a List containing port/sguid dictionaries for easier access e.g. assuming
TODO: document dictionary structure the return value of this function is assigned to stream_stats,
stream_stats.port[1].sguid[101].tx_pkts
This method is a wrapper around the actual getStreamStats() RPC
""" """
class StreamStatsDict: class StreamStatsDict:
def __repr__(self): def __repr__(self):