add undocumented platform parameters for streams.get_all

Author: anxdpanic

resources/lib/twitch/api/parameters.py

@@ -72,6 +72,14 @@ class StreamType(_Parameter):
     _valid = [LIVE, PLAYLIST, ALL]
 
 
+class Platform(_Parameter):
+    XBOX_ONE = 'xbox_one'
+    PS4 = 'ps4'
+    ALL = 'all'
+
+    _valid = [XBOX_ONE, PS4, ALL]
+
+
 class Cursor(_Parameter):
     @classmethod
     def validate(cls, value):

resources/lib/twitch/api/v5/streams.py

@@ -2,7 +2,7 @@
 # https://dev.twitch.tv/docs/v5/reference/streams/
 
 from twitch import keys
-from twitch.api.parameters import StreamType, Language
+from twitch.api.parameters import Boolean, StreamType, Language, Platform
 from twitch.queries import V5Query as Qry
 from twitch.queries import query
 
@@ -17,15 +17,21 @@ def by_id(channel_id, stream_type=StreamType.LIVE):
 
 
 # required scope: none
+# platform undocumented / unsupported
 @query
 def get_all(game=None, channel_ids=None, community_id=None, language=Language.ALL,
-            stream_type=StreamType.LIVE, limit=25, offset=0):
+            stream_type=StreamType.LIVE, platform=Platform.ALL, limit=25, offset=0):
     q = Qry('streams')
     q.add_param(keys.GAME, game)
     q.add_param(keys.CHANNEL, channel_ids)
     q.add_param(keys.COMMUNITY_ID, community_id)
     q.add_param(keys.LANGUAGE, Language.validate(language), Language.ALL)
     q.add_param(keys.STREAM_TYPE, StreamType.validate(stream_type), StreamType.LIVE)
+    platform = Platform.validate(platform)
+    if platform == Platform.XBOX_ONE:
+        q.add_param(keys.XBOX_HEARTBEAT, Boolean.TRUE)
+    elif platform == Platform.PS4:
+        q.add_param(keys.SCE_PLATFORM, 'PS4')
     q.add_param(keys.LIMIT, limit, 25)
     q.add_param(keys.OFFSET, offset, 0)
     return q

resources/lib/twitch/keys.py

@@ -55,6 +55,7 @@
 QUERY = 'query'
 REASON = 'reason'
 RULES = 'rules'
+SCE_PLATFORM = 'sce_platform'
 SHARE = 'share'
 SIG = 'sig'
 SORT = 'sort'
@@ -75,3 +76,4 @@
 USER_ID = 'user_id'
 VIDEO_ID = 'video_id'
 VOD = 'vod'
+XBOX_HEARTBEAT = 'xbox_heartbeat'