Skip to content

RTMP Service Methods

eddy5641 edited this page Aug 2, 2014 · 33 revisions

This is a (probably incomplete) list of the service methods of LoL's RTMP Server. All calls are sent to the destination my-rtmps.

##Services

##Data Types

Here is a list of some Parameter types which are commonly used on this page.

All types that are not on this list are League of Legends specific classes, that can be found in another article(Soon™)

Type Description
double IEEE754 64-Bit double precision floating point number
int 32-bit signed integer
uint 32-bit unsigned integer
boolean true or false
String UTF8 encoded String
null nothing

SpellbookService

###Methods

Service Name Method Name Number of Parameters
spellBookService getSpellBook 1

###Method details

getSpellBook

Parameters: 1. double SummonerId | A summoner ID

Returns: SpellbookDTO


##MasterybookService

###Methods

Service Name Method Name Number of Parameters
masteryBookService getMasteryBook 1
masteryBookService saveMasteryBook 1

###Method details

getMasteryBook

Parameters: 1. double SummonerId | A summoner ID

Returns: MasteryBookDTO


saveMasteryBook

Parameters: 1. MasteryBookDTO MasteryBookPage | The set of mastery pages you want to save to server

Returns: MasteryBookDTO


SummonerService

###Methods

Service Name Method Name Number of Parameters
summonerService getAllSummonerDataByAccount 1
summonerService getSummonerByName 1
summonerService getAllPublicSummonerDataByAccount 1
summonerService getSummonerInternalNameByName 1
summonerService updateProfileIconId 1
summonerService getSummonerNames 1

###Method details

getAllSummonerDataByAccount

Parameters: 1. double AccountId | An account ID

Returns: AllSummonerData


getSummonerByName

Parameters: 1. String Summoner_Name | The name of a summoner

Returns: PublicSummoner


getAllPublicSummonerDataByAccount

Parameters: 1. double AccountId | An account ID

Returns: AllPublicSummonerDataDTO


getSummonerInternalNameByName

Parameters: 1. String Summoner_Name | The name of a summoner

Returns: String


updateProfileIconId

Parameters: 1. int IconId | An icon ID

Returns: null


getSummonerNames

Parameters: 1. double[] Summoner_IDs | An array of summoner IDs

Returns: String[]


RerollService

###Methods

Service Name Method Name Number of Parameters
lcdsRerollService getPointsBalance 0
lcdsRerollService roll 0

###Method details

getPointsBalance

Returns: PointSummary


roll

Returns: RollResult


PlayerStatsService

###Methods

Service Name Method Name Number of Parameters
playerStatsService processEloQuestionaire 1
playerStatsService getAggregatedStats 3
playerStatsService getTeamAggregatedStats 1
playerStatsService getTeamEndOfGameStats 2
playerStatsService retrievePlayerStatsByAccountId 2
playerStatsService getRecentGames 1
playerStatsService retrieveTopPlayedChampions 2

###Method details

processEloQuestionaire

Parameters:

1. String level | "BEGINNER","VETERAN","RTS_PLAYER"

Returns: null


getAggregatedStats

Parameters:

1. double accountId | An account ID

2. String queue | A Queue name

3. int season | The season

Returns: AggregatedStats


getTeamAggregatedStats

Parameters:

1. TeamId teamId | A Team ID

Returns: TeamAggregatedStatsDTO


getTeamEndOfGameStats

Parameters:

1. TeamId teamId | A Team ID

2. double gameId | A game ID

Returns: EndOfGameStats


retrievePlayerStatsByAccountId

Parameters:

1. double accountId | An account ID

2. int season | The season

Returns: PlayerLifetimeStats


getRecentGames

Parameters:

1. double accountId | An account ID

Returns: RecentGames


retrieveTopPlayedChampions

Parameters:

1. double accountId | An account ID

2. String gameMode | A game mode("CLASSIC","ODIN","ARAM")

Returns: ChampionStatInfo[]


MatchmakerService

###Methods

Service Name Method Name Number of Parameters
matchmakerService attachToQueues 1
matchmakerService getQueueInfo 1
matchmakerService attachTeamToQueue 1
matchmakerService purgeFromQueues 0
matchmakerService attachToQueue 1
matchmakerService acceptInviteForMatchmakingGame 1
matchmakerService cancelFromQueueIfPossible 1
matchmakerService getAvailableQueues 0
matchmakerService isMatchmakingEnabled 0
matchmakerService attachTeamToQueues 1

###Method details

attachToQueues

Parameters:

1. MatchMakerParams Parameters | The parameters of the queue being attached to

Returns: SearchingForMatchNotification


getQueueInfo

Parameters:

1. double queueId | A queue ID

Returns: QueueInfo


attachTeamToQueue

Parameters:

1. MatchMakerParams Parameters | The parameters of the queue being attached to

Returns: SearchingForMatchNotification


purgeFromQueues

Returns: ???


attachToQueue

Parameters:

1. MatchMakerParams Parameters | The parameters of the queue being attached to

Returns: SearchingForMatchNotification


acceptInviteForMatchmakingGame ~ DEPRECATED!

Parameters:

1. String teamId | The team ID, the invitation comes from

Returns: null


cancelFromQueueIfPossible

Parameters:

1. double summonerId | A summoner ID

Returns: boolean


getAvailableQueues

Returns: GameQueueConfig[]


isMatchmakingEnabled

Returns: boolean


attachTeamToQueues

Parameters:

1. MatchMakerParams Parameters | The parameters of the queue being attached to

Returns: SearchingForMatchNotification


InventoryService

###Methods

Service Name Method Name Number of Parameters
inventoryService getSumonerActiveBoosts 0
inventoryService getAvailableChampions 0

###Method details

getSumonerActiveBoosts

Returns: SummonerActiveBoostsDTO


getAvailableChampions

Returns: ChampionDTO[]


SummonerIconService

###Method details

Service Name Method Name Number of Parameters
summonerIconService getSummonerIconInventory 1

###Methods getSummonerIconInventory

Parameters: 1. double SummonerId | A summoner ID

Returns: SummonerIconInventoryDTO


GameService

###Method details

Service Name Method Name Number of Parameters
gameService listAllPracticeGames 0
gameService joinGame 2
gameService observeGame 2
gameService switchTeams 1
gameService switchPlayerToObserver 1
gameService switchObserverToPlayer 1
gameService quitGame 0
gameService createPracticeGame 1
gameService startChampionSelection 2
gameService setClientReceivedGameMessage 2
gameService getLatestGameTimerState 3
gameService selectSpells 2
gameService acceptPoppedGame 1
gameService createTutorialGame 1
gameService retrieveInProgressSpectatorGameInfo 1
gameService getSkinUnlockPrice 1
gameService unlockSkinsForTeam 1
gameService joinOrCreatePracticeGame 1

###Methods

listAllPracticeGames

Returns: PracticeGameSearchResult[]


joinGame

Parameters: 1. double GameId | The gameId of the custom game you are joining

2. String Password | Password of the custom game you are joining. null if empty

Returns: null


observeGame

Parameters: 1. double GameId | The gameId of the custom game you are spectating

2. String Password | Password of the custom game you are spectating. null if empty

Returns: null


switchTeams

Parameters: 1. double GameId | The gameId of the current custom game

Returns: bool


switchPlayerToObserver

Parameters: 1. double GameId | The gameId of the current custom game

Returns: bool


switchObserverToPlayer

Parameters: 1. Double GameId | The gameId of the current custom game

Returns: bool


quitGame

Returns: null


createPracticeGame

Parameters: 1. PracticeGameConfig CustomGameConfig | The configuration for the custom game

Returns: GameDTO


startChampionSelection

Parameters: 1. double GameId | The game id of the custom game

2. double OptomisticLock | The optomstic lock (provided by GameDTO)

Returns: StartChampSelectDTO


setClientReceivedGameMessage

Parameters: 1. double GameID | The Game ID

2. String Argument | The argument to be passed

Returns: null


getLatestGameTimerState

Parameters: 1. double GameID | The game ID

2. String GameState | "TERMINATED", "TERMINATED_IN_ERROR", "PRE_CHAMP_SELECT", "CHAMP_SELECT", "POST_CHAMP_SELECT", "START_REQUESTED"

3. int PickTurn | The current pick turn

Returns: GameDTO


selectSpells

Parameters: 1. int SpellOne | Id of the first spell

2. int SpellTwo | Id of the second spell

Returns: null


acceptPoppedGame

Parameters: 1. boolean Accept | If accepting queue or not

Returns: null


createTutorialGame

Parameters: 1. double ??? | ???

Returns: GameDTO


retrieveInProgressSpectatorGameInfo

Parameters: 1. String Summoner_Name | The name of a summoner

Returns: PlatformGameLifecycleDTO


getSkinUlnockPrice

Parameters: 1. String currency | The currency (usually "RP")

Returns: ???


unlockSkinsForTeam

Parameters: 1. String currency | The currency (usually "RP")

Returns: ???


joinOrCreatePracticeGame

Parameters: 1. PracticeGameConfig config | The game configuration (name, password, mode, etc.)

Returns: GameDTO


LeaguesService

###Methods

Service Name Method Name Number of Parameters
leaguesServiceProxy getLeagueForPlayer 1

###Method details

getLeagueForPlayer

Parameters:

1. int AccountId | An Account ID

Returns: List[LeagueDto] (see Riot API)


lcdsServiceProxy

###Methods

Service Name Method Name Number of Parameters
lcdsServiceProxy createGroupFinderLobby 2
lcdsServiceProxy call 4
lcdsServiceProxy *acceptCandidateV2 1
lcdsServiceProxy *createGroupV3 1
lcdsServiceProxy *declineCandidateV2 1
lcdsServiceProxy *retrieveFeatureToggles 0
lcdsServiceProxy *pickChampionV2 1
lcdsServiceProxy *specifyAdvertisedRoleV1 2
lcdsServiceProxy *specifyPositionV2 2
lcdsServiceProxy *specifyRoleV2 2
lcdsServiceProxy *startGroupBuildingPhaseV1 0
lcdsServiceProxy *startMatchmakingPhaseV1 0
lcdsServiceProxy *retrievePlayerInfoV3 1
lcdsServiceProxy *startSoloSpecPhaseV2 0

UUID is generated in ClientLibCommon|com.riotgames.platform.common.utils.GUID

###Method details createGroupFinderLobby

Parameters: 1. double ??? | ???

2. String GroupFinderUUID | The generated UUID of the group finder lobby

Returns: LobbyStatus


call

Parameters: 1. String GroupFinderUUID | The generated UUID of the group finder lobby

2. String GameMode | The game mode (usually "cap")

3. String ProcedureCall | The procedure to call

4. String Parameters | The parameters to pass in JSON encoded format

Returns: null


All calls below here in the lcdsServiceProxy section are sent through the call method. None of them return values through the call but through the cn channel.

acceptCandidateV2

Parameters: 1. double slotId | The location of the candidate you want to accept


createGroupV3

Parameters: 1. double queueId | The queue you want to queue up for


declineCandidateV2

Parameters: 1. double SlotId | The location of the candidate you want to decline


retrieveFeatureToggles


pickChampionV2

Parameters: 1. double ChampionId | The champion you want to queue up with


specifyAdvertisedRoleV1

Parameters: 1. double slotId | The slot id

2. double advertisedRole | The role you want in that slot


specifyPositionV2

Parameters: 1. double slotId | The slot id

2. double position | The position you want in that slot


specifyPositionV2

Parameters: 1. double slotId | The slot id

2. double role | The role you want in that slot


startGroupBuildingPhaseV1


startMatchmakingPhaseV1


retrievePlayerInfoV3

Parameters: 1. Double queueId | The queue id


startSoloSpecPhaseV2


lcdsGameInvitationService

###Methods

Service Name Method Name Number of Parameters
lcdsGameInvitationService createGroupFinderLobby 2
lcdsGameInvitationService createArrangedTeamLobby 1
lcdsGameInvitationService createArrangedBotTeamLobby 2
lcdsGameInvitationService getLobbyStatus 1
lcdsGameInvitationService getPendingInvitations 0
lcdsGameInvitationService grantInvitePrivileges 1
lcdsGameInvitationService invite 1
lcdsGameInvitationService leave 0
lcdsGameInvitationService transferOwnership 1
lcdsGameInvitationService accept 1
lcdsGameInvitationService decline 0

##Method details

createGroupFinderLobby

Parameters: 1. double GameMode | The game mode being used (61)

2. String GroupFinderUUID | The generated UUID of the group finder lobby

Returns: LobbyStatus


createArrangedTeamLobby

Parameters: 1. double QueueId | A queue Id

Returns: LobbyStatus


createArrangedBotTeamLobby

Parameters: 1. double ??? | ???

2. String Difficulty | ???

Returns: LobbyStatus


getLobbyStatus

//This is no longer used. Riot has removed getLobbyStatus because it is also sent by accept Returns: LobbyStatus


getPendingInvitations

Returns: ???[]


grantInvitePrivileges

Parameters: 1. double Summoner_ID | A summoner id

Returns: null


transferOwnership

Parameters: 1. double Summoner_ID | A summoner id

Returns: null


invite

Parameters: 1. double Summoner_ID | A summoner id

Returns: null


leave

Returns: null


accept

Parameters: 1. String Invitation_ID | An invitation ID, looks like INVID158928100

Returns: LobbyStatus


decline

Parameters: 1. String Invitation_ID | An invitation ID, looks like INVID158928100

Returns: null


LcdsChampionTradeService

###Methods

Service Name Method Name Number of Parameters
lcdsChampionTradeService attemptTrade 3
lcdsChampionTradeService dismissTrade 0
lcdsChampionTradeService getPotentialTraders 0

###Method details

attemptTrade

Parameters: 1. String Summoner_Internal_Name | The internal name of a summoner you are attempting/accepting a trade to/from

2. int ChampionID | The champion ID that you are attempting/accepting to trade/trade with

3. boolean IsAcceptingTrade | True -> If you are accepting a trade from another summoner | False -> If you are sending a trade to a summoner

Returns: null


dismissTrade

Returns: null


getPotentialTraders

Returns: PotentialTradersDTO


Clone this wiki locally